Merge branch 'main' into change_list

.github/workflows/publish-to-pypi.yml

@@ -16,7 +16,7 @@ jobs:
     - name: Install pypa/build
       run: >-
         python3 -m
-        pip install
+        pip install -r requirements.txt
         build
         --user
     - name: Build a binary wheel and a source tarball

.github/workflows/ruff.yml

@@ -0,0 +1,10 @@
+name: Ruff
+
+on: [ push, pull_request ]
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: chartboost/ruff-action@v1

.gitignore

@@ -2,4 +2,5 @@ dist/
 python_bring_api.egg-info/
 test/
 .venv
-__pycache__
+__pycache__
+.ruff_cache

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.2.1
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format

.vscode/settings.json

@@ -2,5 +2,12 @@
   "cSpell.words": [
     "aiohttp",
     "asyncio"
-  ]
+  ],
+  "[python]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.codeActionsOnSave": {
+      "source.fixAll": true
+    }
+  }
 }

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.1.2
+
+Add ruff as formatter and linter.
+
 ## 0.1.1
 
 Change name of package to `bring-api`.

README.md

@@ -202,3 +202,26 @@ You can fix this according to [this](https://stackoverflow.com/questions/6812329
 ```python
 asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
 ```
+
+## Dev
+
+Setup the dev environment using VSCode, is is highly recommended.
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -r requirements_dev.txt
+```
+
+Install [pre-commit](https://pre-commit.com)
+
+```bash
+pre-commit install
+
+# Run the commit hooks manually
+pre-commit run --all-files
+```
+
+Following VSCode integrations may be helpful:
+
+* [ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff)

bring_api/__init__.py

@@ -0,0 +1 @@
+"""Bring API package."""