refactor!: migrate the whole project to pyproject.toml project defi…

…nition (#92) #92
palazzem · Aug 25, 2023 · fa9f4e7 · fa9f4e7
2 parents 0dfd637 + d0ba14b
commit fa9f4e7
Show file tree

Hide file tree

Showing 20 changed files with 97 additions and 140 deletions.
diff --git a/.github/workflows/linting.yaml b/.github/workflows/linting.yaml
@@ -5,7 +5,6 @@ on:
   push:
     branches:
       - main
-      - upstream
   pull_request:
 
 permissions:
@@ -31,8 +30,7 @@ jobs:
       - name: Upgrade pip and install required tools
         run: |
           pip install --upgrade pip
-          pip install -r requirements.txt
-          pip install tox -U
+          pip install tox
 
       - name: Lint codebase
         run: tox -e lint
diff --git a/.github/workflows/testing.yaml b/.github/workflows/testing.yaml
@@ -5,7 +5,6 @@ on:
   push:
     branches:
       - main
-      - upstream
   pull_request:
 
 permissions:
@@ -37,8 +36,7 @@ jobs:
       - name: Upgrade pip and install required tools
         run: |
           pip install --upgrade pip
-          pip install -r requirements.txt
-          pip install tox -U
+          pip install tox
 
       - name: Test with tox environments
         run: tox
diff --git a/README.md b/README.md
@@ -81,9 +81,24 @@ and ask for help in our [Discord channel](https://discord.gg/NSmAPWw8tE) if you
 
 ## Development
 
-We accept external contributions even though the project is mostly designed for personal
-needs. If you think some parts can be exposed with a more generic interface, feel free
-to open a GitHub issue and to discuss your suggestion.
+We welcome external contributions, even though the project was initially intended for personal use. If you think some
+parts could be exposed with a more generic interface, please open a [GitHub issue](https://github.com/palazzem/econnect-python/issues)
+to discuss your suggestion.
+
+### Dev Environment
+
+To create a virtual environment and install the project and its dependencies, execute the following commands in your
+terminal:
+
+```bash
+# Create and activate a new virtual environment
+python3 -m venv venv
+source venv/bin/activate
+
+# Upgrade pip and install all projects and their dependencies
+pip install --upgrade pip
+pip install -e '.[all]'
+```
 
 ### Coding Guidelines
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,61 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "elmo"
+dynamic = ["version"]
+description = 'API adapter used to control programmatically an Elmo alarm system'
+readme = "README.md"
+requires-python = ">=3.5"
+license = "Apache-2.0"
+keywords = []
+authors = [
+  { name = "Emanuele Palazzetti", email = "emanuele.palazzetti@gmail.com" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.5",
+  "Programming Language :: Python :: 3.6",
+  "Programming Language :: Python :: 3.7",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = [
+  "requests[security]",
+]
+
+[project.optional-dependencies]
+dev = [
+  "mypy",
+  # Test
+  "pytest",
+  "pytest-cov",
+  "pytest-mock",
+  "responses",
+  "tox",
+]
+
+lint = [
+  "black",
+  "flake8",
+]
+
+all = [
+  "elmo[dev]",
+  "elmo[lint]",
+]
+
+[project.urls]
+Documentation = "https://github.com/palazzem/econnect-python#readme"
+Issues = "https://github.com/palazzem/econnect-python/issues"
+Source = "https://github.com/palazzem/econnect-python"
+
+[tool.hatch.version]
+path = "src/elmo/__about__.py"
+
+[tool.hatch.metadata]
+allow-direct-references = true
diff --git a/requirements.txt b/requirements.txt
diff --git a/requirements/requirements-linting.in b/requirements/requirements-linting.in
diff --git a/requirements/requirements-linting.txt b/requirements/requirements-linting.txt
diff --git a/requirements/requirements-testing.in b/requirements/requirements-testing.in
diff --git a/requirements/requirements-testing.txt b/requirements/requirements-testing.txt
diff --git a/src/elmo/__about__.py b/src/elmo/__about__.py
@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2023-present Emanuele Palazzetti <emanuele.palazzetti@gmail.com>
+#
+# SPDX-License-Identifier: MIT
+__version__ = "0.4.0"
diff --git a/elmo/__init__.py → src/elmo/__init__.py b/elmo/__init__.py → src/elmo/__init__.py
diff --git a/elmo/api/__init__.py → src/elmo/api/__init__.py b/elmo/api/__init__.py → src/elmo/api/__init__.py
diff --git a/elmo/api/client.py → src/elmo/api/client.py b/elmo/api/client.py → src/elmo/api/client.py
diff --git a/elmo/api/decorators.py → src/elmo/api/decorators.py b/elmo/api/decorators.py → src/elmo/api/decorators.py
diff --git a/elmo/api/exceptions.py → src/elmo/api/exceptions.py b/elmo/api/exceptions.py → src/elmo/api/exceptions.py
diff --git a/elmo/api/router.py → src/elmo/api/router.py b/elmo/api/router.py → src/elmo/api/router.py
diff --git a/elmo/const.py → src/elmo/const.py b/elmo/const.py → src/elmo/const.py
diff --git a/elmo/devices.py → src/elmo/devices.py b/elmo/devices.py → src/elmo/devices.py
diff --git a/elmo/query.py → src/elmo/query.py b/elmo/query.py → src/elmo/query.py
diff --git a/tox.ini b/tox.ini
@@ -1,30 +1,30 @@
 [tox]
 envlist =
     lint
-    py{36}
-    py{37}
-    py{38}
-    py{39}
+    py3.6
+    py3.7
+    py3.8
+    py3.9
 
 [testenv]
-setenv =
-    PYTHONPATH = {toxinidir}
-    PYTHONDONTWRITEBYTECODE=1
-deps = -r requirements/requirements-testing.txt
+allowlist_externals = pytest
+deps =
+    -e .[dev]
 commands =
     pytest tests/ --cov elmo -s -v
 
 [testenv:lint]
 skip_install = true
-deps = -r requirements/requirements-linting.txt
+deps =
+    -e .[lint]
 basepython =
     python3.9
 commands =
-    flake8 elmo/ tests/ --exclude=elmo/const.py
-    black elmo/ tests/ --check
+    flake8 src/elmo/ tests/ --exclude=src/elmo/const.py
+    black src/elmo/ tests/ --check
 
 [flake8]
 max-line-length = 120
 exclude =
     .tox
-    conftest.py  # Contains fixtures
+    conftest.py  # Contains fixtures