Merge pull request #2 from kzosabe/publish-first-version

Publish first version

Author: kzosabe

.github/workflows/main.yml

@@ -0,0 +1,43 @@
+name: Delivery
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  test:
+    name: Run tests with pytest
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.7, 3.8, 3.9]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install poetry
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install poetry
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v2
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: poetry install --no-interaction --no-root
+
+      - name: Run Tests
+        run: ./scripts/run_tests.sh

.gitignore

@@ -1,4 +1,7 @@
 __pycache__/
 *.py[cod]
 *$py.class
+build/
+dist/
+.idea
 !.keep

LICENSE-APACHE

@@ -1,3 +1,4 @@
+
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
@@ -198,4 +199,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

LICENSE-MIT

@@ -1,7 +1,3 @@
-MIT License
-
-Copyright (c) 2021 Arnav Yash Chandra <arnavyash2004@outlook.com>
-
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights

README.md

@@ -139,11 +139,47 @@ SwitchBotAPIResponse(status_code=100, message='success', body={})
 The specified scene can be executed immediately.
 
 
+### Examples
+
+```python
+from switchbot_client.enums import ControlCommand
+from switchbot_client import SwitchBotAPIClient
+
+
+def control_all_infrared_remotes_by_type(type: str, command: str):
+    client = SwitchBotAPIClient()
+    devices = client.devices()
+    infrared_remotes = devices.body["infraredRemoteList"]
+    devices = filter(lambda d: d["remoteType"] == type, infrared_remotes)
+
+    for d in devices:
+        client.devices_control(d["deviceId"], command)
+
+
+def call_this_function_when_i_go_out():
+    print("turn off all lights and air conditioners...")
+    control_all_infrared_remotes_by_type(
+        "Light", ControlCommand.VirtualInfrared.TURN_OFF
+    )
+    control_all_infrared_remotes_by_type(
+        "Air Conditioner", ControlCommand.VirtualInfrared.TURN_OFF
+    )
+    print("done")
+```
+
 ## License
 
 Licensed under either of
 
-- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
-- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+ * Apache License, Version 2.0
+   ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT license
+   ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
 
 at your option.
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.