Migrate to poetry

Author: PiotrMachowski

.github/workflows/code_quality.yaml

@@ -1,17 +1,26 @@
-name: Actions
+name: Code Quality
 
 on:
   pull_request:
     branches:
       - master
   push:
-    branches:
-      - master
 
 jobs:
-  lint:
-    name: Lint
+  code_quality:
+    name: Code Quality
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - id: black
+            name: Check code style with black
+          - id: isort
+            name: Check if imports are sorted with isort
+          - id: pylint
+            name: Check code with pylint
+          - id: mypy
+            name: Check code with pylint
     steps:
       - name: Checkout the repository
         uses: actions/checkout@v3
@@ -22,20 +31,12 @@ jobs:
         with:
           python-version: "3.11"
 
-      - name: Install dependencies
-        run: pip install -r requirements.txt
-
-      - name: Install dev dependencies
-        run: pip install -r requirements-dev.txt
-
-      - name: Lint with Black
-        run: black --check src
-
-      - name: Lint with mypy
-        run: mypy --strict src
+      - name: Install workflow dependencies
+        run: |
+          pip install -r .github/workflows/requirements.txt
 
-      - name: Lint with pylint
-        run: pylint src --rcfile pylint.rc
+      - name: Install Python dependencies
+        run: poetry install --no-interaction
 
-      - name: Lint with isort
-        run: isort --check-only --profile black src
+      - name: Run ${{ matrix.id }} checks
+        run: poetry run ${{ matrix.id }} src

.github/workflows/release.yml

@@ -1,45 +1,43 @@
-name: Publish releases
+name: Publish release
 
 on:
   release:
     types: [published]
 
 jobs:
   build-and-publish-pypi:
-    name: Builds and publishes releases to PyPI
+    name: Builds and publishes release to PyPI
     runs-on: ubuntu-latest
     outputs:
       version: ${{ steps.vars.outputs.tag }}
     steps:
       - uses: actions/checkout@v3.5.3
-      - name: Get tag
-        id: vars
-        run: echo "tag=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT
+
       - name: Set up Python 3.11
         uses: actions/setup-python@v4.7.0
         with:
           python-version: "3.11"
-      - name: Install build
-        run: >-
-          pip install build tomli tomli-w
-      - name: Set Python project version from tag
-        shell: python
-        run: |-
-          import tomli
-          import tomli_w
-
-          with open("pyproject.toml", "rb") as f:
-            pyproject = tomli.load(f)
-
-          pyproject["project"]["version"] = "${{ steps.vars.outputs.tag }}"
-
-          with open("pyproject.toml", "wb") as f:
-            tomli_w.dump(pyproject, f)
-      - name: Build
-        run: >-
-          python3 -m build
-      - name: Publish release to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.8.10
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_TOKEN }}
+
+      - name: Install workflow dependencies
+        run: |
+          pip install -r .github/workflows/requirements.txt
+
+      - name: Install dependencies
+        run: poetry install --no-interaction
+
+      - name: Set package version
+        run: |
+          version="${{ github.event.release.tag_name }}"
+          version="${version,,}"
+          version="${version#v}"
+          poetry version --no-interaction "${version}"
+
+      - name: Build package
+        run: poetry build --no-interaction
+
+      - name: Publish to PyPi
+        env:
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          poetry config pypi-token.pypi "${PYPI_TOKEN}"
+          poetry publish --no-interaction

.github/workflows/requirements.txt

@@ -0,0 +1,2 @@
+pip==23.2.1
+poetry==1.5.1

README.md

@@ -14,7 +14,7 @@
 [pypi_releases_shield]: https://img.shields.io/pypi/v/vacuum-map-parser-base
 
 [pypi_downloads]: https://pepy.tech/project/vacuum-map-parser-base
-[pypi_downloads_shield]: https://pepy.tech/badge/vacuum-map-parser-base/month
+[pypi_downloads_shield]: https://static.pepy.tech/badge/vacuum-map-parser-base
 
 # Vacuum map parser - base
 
@@ -24,7 +24,7 @@ Available implementations:
 * [`vacuum-map-parser-roborock`](https://github.com/PiotrMachowski/Python-package-vacuum-map-parser-roborock)
 * [`vacuum-map-parser-viomi`](https://github.com/PiotrMachowski/Python-package-vacuum-map-parser-viomi)
 * [`vacuum-map-parser-roidmi`](https://github.com/PiotrMachowski/Python-package-vacuum-map-parser-roidmi)
-* [`vacuum-map-parser-viomi`](https://github.com/PiotrMachowski/Python-package-vacuum-map-parser-viomi)
+* [`vacuum-map-parser-dreame`](https://github.com/PiotrMachowski/Python-package-vacuum-map-parser-dreame)
 
 ## Installation
 

pyproject.toml

@@ -1,32 +1,71 @@
-[build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
-
-[project]
+[tool.poetry]
 name = "vacuum-map-parser-base"
 # The version is set by GH action on release
 version = "0.0.0"
-license = { text = "Apache-2.0" }
+license = "Apache-2.0"
 description = "Common code for vacuum map parsers"
 readme = "README.md"
-requires-python = ">=3.11"
-authors = [
-    { name = "Piotr Machowski", email = "piotr.machowski.dev@gmail.com" }
-]
+authors = ["Piotr Machowski <piotr.machowski.dev@gmail.com>"]
 classifiers = [
     "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
     "Environment :: Console",
     "Programming Language :: Python :: 3.11",
     "Topic :: Home Automation",
 ]
-dynamic = ["dependencies"]
+packages = [
+    { include = "vacuum_map_parser_base", from = "src" },
+]
 
-[project.urls]
+[tool.poetry.urls]
 "Homepage" = "https://github.com/PiotrMachowski/Python-package-vacuum-map-parser-base"
 "Repository" = "https://github.com/PiotrMachowski/Python-package-vacuum-map-parser-base"
 "Bug Tracker" = "https://github.com/PiotrMachowski/Python-package-vacuum-map-parser-base/issues"
+"Changelog" = "https://github.com/PiotrMachowski/Python-package-vacuum-map-parser-base/releases"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+Pillow = "*"
+
+[tool.poetry.dev-dependencies]
+black = "*"
+mypy = "*"
+ruff = "*"
+isort = "*"
+pylint = "*"
+types-Pillow = "*"
 
-[tool.setuptools.dynamic]
-dependencies = { file = ["requirements.txt"] }
-optional-dependencies = {dev = { file = ["requirements-dev.txt"] }}
+[tool.black]
+line-length = 120
+
+[tool.isort]
+profile = "black"
+line_length = 120
+
+[tool.mypy]
+platform = "linux"
+
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_subclassing_any = true
+disallow_untyped_calls = true
+disallow_untyped_defs = true
+disallow_untyped_decorators = true
+no_implicit_optional = true
+no_implicit_reexport = true
+strict_optional = true
+warn_incomplete_stub = true
+warn_no_return = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unused_configs = true
+warn_unused_ignores = true
+
+[tool.pylint]
+disable = ["C0103", "C0116", "R0902", "R0903", "R0913", "R0914", "W0640"]
+max-line-length = 120
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

src/vacuum_map_parser_base/config/color.py

@@ -121,9 +121,7 @@ def __init__(
     def get_color(self, color_name: SupportedColor) -> Color:
         return self._overriden_colors.get(
             color_name,
-            ColorsPalette.COLORS.get(
-                color_name, ColorsPalette.COLORS.get(SupportedColor.UNKNOWN, (0, 0, 0))
-            ),
+            ColorsPalette.COLORS.get(color_name, ColorsPalette.COLORS.get(SupportedColor.UNKNOWN, (0, 0, 0))),
         )
 
     def get_room_color(self, room_id: str | int) -> Color:
@@ -137,8 +135,6 @@ def get_room_color(self, room_id: str | int) -> Color:
             key,
             ColorsPalette.ROOM_COLORS.get(
                 key,
-                ColorsPalette.ROOM_COLORS.get(
-                    str(self._random.randint(1, 16)), (0, 0, 0)
-                ),
+                ColorsPalette.ROOM_COLORS.get(str(self._random.randint(1, 16)), (0, 0, 0)),
             ),
         )