V1.1.0

.all-contributorsrc

@@ -0,0 +1,28 @@
+{
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "commitType": "docs",
+  "commitConvention": "angular",
+  "contributors": [
+    {
+      "login": "brg468",
+      "name": "Brian Rogers",
+      "avatar_url": "https://avatars.githubusercontent.com/u/19143191?v=4",
+      "profile": "https://github.com/brg468",
+      "contributions": [
+        "code",
+        "doc",
+        "test"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "skipCi": true,
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "projectName": "rachiopy",
+  "projectOwner": "rfverbruggen"
+}

.all-contributorsrc.json

@@ -0,0 +1,4 @@
+{
+  "projectName": "rachiopy",
+  "projectOwner": "rfverbruggen"
+}

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ dev, master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ dev ]
+  schedule:
+    - cron: '28 6 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/lint.yml

@@ -6,18 +6,14 @@ jobs:
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        python-version: [3.6, 3.7, 3.8]
-
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
     # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
     - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
+    - name: Set up Python 3.x
       uses: actions/setup-python@v2
       with:
-        python-version: ${{ matrix.python-version }}
+        python-version: 3.x
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -28,4 +24,4 @@ jobs:
     - name: Run flake8
       run: flake8
     - name: Run pydocstyle
-      run: pydocstyle {posargs:rachiopy tests}
+      run: pydocstyle {posargs:rachiopy tests}

.github/workflows/publish.yml

@@ -7,13 +7,18 @@ on:
 jobs:
   build-n-publish:
     name: Build and publish Python distributions to PyPI
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/RachioPy
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
     steps:
     - uses: actions/checkout@master
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v1
+    - name: Set up Python 3.x
+      uses: actions/setup-python@v2
       with:
-        python-version: 3.8
+        python-version: 3.x
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip setuptools wheel
@@ -25,12 +30,9 @@ jobs:
       run: python setup.py sdist bdist_wheel
     - name: Publish distribution to Test PyPI
       if: startsWith(github.ref, 'refs/tags')
-      uses: pypa/gh-action-pypi-publish@master
+      uses: pypa/gh-action-pypi-publish@release/v1
       with:
-        password: ${{ secrets.test_pypi_password }}
-        repository_url: https://test.pypi.org/legacy/
+        repository-url: https://test.pypi.org/legacy/
     - name: Publish distribution to PyPI
       if: startsWith(github.ref, 'refs/tags')
-      uses: pypa/gh-action-pypi-publish@master
-      with:
-        password: ${{ secrets.pypi_password }}
+      uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/publish_test.yml

@@ -8,13 +8,18 @@ on:
 jobs:
   build-n-publish:
     name: Build and publish Python distributions to Test PyPI
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://test.pypi.org/project/RachioPy
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
     steps:
     - uses: actions/checkout@master
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v1
+    - name: Set up Python 3.x
+      uses: actions/setup-python@v2
       with:
-        python-version: 3.8
+        python-version: 3.x
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip setuptools wheel
@@ -24,8 +29,7 @@ jobs:
       run: python -m unittest discover -v tests
     - name: Build distribution
       run: python setup.py sdist bdist_wheel
-    - name: Publish distribution to Test PyPI
-      uses: pypa/gh-action-pypi-publish@master
+    - name: Publish package distributions to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
       with:
-        password: ${{ secrets.test_pypi_password }}
-        repository_url: https://test.pypi.org/legacy/
+        repository-url: https://test.pypi.org/legacy/

.github/workflows/test.yml

@@ -8,7 +8,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
@@ -24,4 +24,4 @@ jobs:
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
         if [ -f requirements_test.txt ]; then pip install -r requirements_test.txt; fi
     - name: Run unittests
-      run: python -m unittest discover -v tests
+      run: python -m unittest discover -v tests

README.md

@@ -1,9 +1,12 @@
-Rachiopy
-========
+# Rachiopy
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
 This python package provides a interface to the Rachio public API.
 
-Usage
------
+## Usage
+
 ```python
 from rachiopy import Rachio
 
@@ -13,3 +16,28 @@ r.person.info()
 ```
 
 For the complete documentation visit [read the docs](https://rachiopy.readthedocs.io/en/latest/).
+
+## Contributors
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/brg468"><img src="https://avatars.githubusercontent.com/u/19143191?v=4?s=100" width="100px;" alt="Brian Rogers"/><br /><sub><b>Brian Rogers</b></sub></a><br /><a href="https://github.com/rfverbruggen/rachiopy/commits?author=brg468" title="Code">💻</a> <a href="https://github.com/rfverbruggen/rachiopy/commits?author=brg468" title="Documentation">📖</a> <a href="https://github.com/rfverbruggen/rachiopy/commits?author=brg468" title="Tests">⚠️</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->

docs/index.rst

@@ -19,7 +19,7 @@ Getting Started
     from rachiopy import Rachio
 
     r = Rachio("8e600a4c-0027-4a9a-9bda-dc8d5c90350d")
-    resp, content = r.person.getInfo()
+    resp, content = r.person.info()
 
     print (resp["status"])
     print (content["id"])

rachiopy/__init__.py

@@ -7,11 +7,15 @@
 from rachiopy.notification import Notification
 from rachiopy.schedulerule import Schedulerule
 from rachiopy.zone import Zone
+from rachiopy.valve import Valve
+from rachiopy.summary import SummaryServce
+from rachiopy.program import Program
 
 
 class Rachio(RachioObject):
     """Object representing the Rachio API."""
 
+    # pylint: disable=too-many-instance-attributes
     def __init__(self, authtoken: str):
         """Initialze the Rachio API wrapper.
 
@@ -25,3 +29,6 @@ def __init__(self, authtoken: str):
         self.notification = Notification(authtoken)
         self.schedulerule = Schedulerule(authtoken)
         self.zone = Zone(authtoken)
+        self.valve = Valve(authtoken)
+        self.summary = SummaryServce(authtoken)
+        self.program = Program(authtoken)

rachiopy/program.py

@@ -0,0 +1,86 @@
+"""Program module for the smart hose timer."""
+
+from rachiopy.rachioobject import RachioObject
+
+
+class Program(RachioObject):
+    """Program class for the smart hose timer."""
+
+    def list_programs(self, valve_id: str):
+        """Retreive the list of programs (schedules) for a valve.
+
+        For more info of the content in the response see:
+        https://rachio.readme.io/docs/programservice_listprograms
+
+        :param valve_id: Valve's unique id
+        :type valve_id: str
+
+        :return: The return value is a tuple of (response, content), the first
+            being and instance of the httplib2.Response class, the second
+            being a string that contains the response entity body.
+        :rtype: tuple
+        """
+        path = f"program/listPrograms/{valve_id}"
+        return self.valve_get_request(path)
+
+    def get_program(self, program_id: str):
+        """Retreive the information for a specific program.
+
+        For more info of the content in the response see:
+        https://rachio.readme.io/docs/programservice_getprogram
+
+        :param program_id: Program's unique id
+        :type program_id: str
+
+        :return: The return value is a tuple of (response, content), the first
+            being and instance of the httplib2.Response class, the second
+            being a string that contains the response entity body (Python
+            object if it contains JSON).
+        :rtype: tuple
+        """
+        path = f"program/getProgram/{program_id}"
+        return self.valve_get_request(path)
+
+    def create_skip_overrides(self, program_id: str, timestamp: str):
+        """Create manual skips for the specific program run time.
+        You can retrieve the runtimes from SummaryService.getValveDayViews
+
+        For more info of the content in the response see:
+        https://rachio.readme.io/docs/programservice_createskipoverrides
+
+        :param program_id: Program's unique id
+        :type program_id: str
+
+        :param timestamp: Timestamp of the run to skip
+        :type timestamp: timestamp
+
+        :return: The return value is a tuple of (response, content), the first
+            being and instance of the httplib2.Response class, the second
+            being a string that contains the response entity body (Python
+            object if it contains JSON).
+        :rtype: tuple
+        """
+        payload = {"programId": program_id, "timestamp": timestamp}
+        return self.valve_post_request("program/createSkipOverrides", payload)
+
+    def delete_skip_overrides(self, program_id: str, timestamp: str):
+        """Cancel program skips for the specified program run time.
+        You can retrieve upcoming skips from SummaryService.getValveDayViews
+
+        For more info of the content in the response see:
+        https://rachio.readme.io/docs/programservice_deleteskipoverrides
+
+        :param program_id: Program's unique id
+        :type program_id: str
+
+        :param timestamp: Timestamp of the run skip to delete
+        :type timestamp: timestamp
+
+        :return: The return value is a tuple of (response, content), the first
+            being and instance of the httplib2.Response class, the second
+            being a string that contains the response entity body (Python
+            object if it contains JSON).
+        :rtype: tuple
+        """
+        payload = {"programId": program_id, "timestamp": timestamp}
+        return self.valve_post_request("program/deleteSkipOverrides", payload)