Migrate as much configuration as possible to pyproject.toml, migrate pylintrc to toml

Author: Syndace

.flake8

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "pypy-3.10"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "pypy-3.10", "pypy-3.11"]
 
     steps:
       - uses: actions/checkout@v4
@@ -27,17 +27,17 @@ jobs:
         run: pip install .
       - name: Install test dependencies
         run: |
-          pip install --upgrade pytest pytest-asyncio pytest-cov mypy pylint flake8 setuptools
+          pip install --upgrade .[test,lint]
           pip install --upgrade twisted twomemo[xml] oldmemo[xml]
 
       - name: Type-check using mypy
-        run: mypy --strict --disable-error-code str-bytes-safe omemo/ setup.py examples/ tests/
+        run: mypy omemo/ examples/ tests/
       - name: Lint using pylint
-        run: pylint omemo/ setup.py examples/ tests/
+        run: pylint omemo/ examples/ tests/
       - name: Format-check using Flake8
-        run: flake8 omemo/ setup.py examples/ tests/
+        run: flake8 omemo/ examples/ tests/
       - name: Test using pytest
-        run: pytest --cov=omemo --cov-report term-missing:skip-covered
+        run: pytest
 
   build:
     name: Build source distribution and wheel
@@ -46,8 +46,11 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Install build
+        run: pip install build
+
       - name: Build source distribution and wheel
-        run: python3 setup.py sdist bdist_wheel
+        run: python -m build --sdist --wheel
 
       - uses: actions/upload-artifact@v4
         with:

.github/workflows/test-and-publish.yml

@@ -11,6 +11,7 @@ sphinx:
 
 python:
   install:
-  - requirements: docs/requirements.txt
   - method: pip
     path: .
+    extra_requirements:
+      - docs

.readthedocs.yaml

@@ -13,6 +13,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Removed type annotations from enum members in accordance with a new mypy rule
 - Simplified the `JSONObject` type now that recursive aliases are properly supported
 
+### Removed
+- Removed project.py and simplified version.py as part of the migration towards pyproject.toml
+
 ## [1.2.0] - 15th of October, 2024
 
 ### Changed

CHANGELOG.md

@@ -18,16 +18,15 @@ Install the latest release using pip (`pip install OMEMO`) or manually from sour
 python-omemo uses [pytest](https://docs.pytest.org/en/latest/) as its testing framework, [mypy](http://mypy-lang.org/) for static type checks and both [pylint](https://pylint.pycqa.org/en/latest/) and [Flake8](https://flake8.pycqa.org/en/latest/) for linting. All tests/checks can be run locally with the following commands:
 
 ```sh
-$ pip install --upgrade pytest pytest-asyncio pytest-cov mypy pylint flake8
-$ pip install --upgrade twisted twomemo[xml] oldmemo[xml]
-$ mypy --strict --disable-error-code str-bytes-safe omemo/ setup.py examples/ tests/
-$ pylint omemo/ setup.py examples/ tests/
-$ flake8 omemo/ setup.py examples/ tests/
-$ pytest --cov=omemo --cov-report term-missing:skip-covered
+$ pip install --upgrade .[test,lint]
+$ mypy omemo/ examples/ tests/
+$ pylint omemo/ examples/ tests/
+$ flake8 omemo/ examples/ tests/
+$ pytest
 ```
 
 ## Getting Started ##
 
-Refer to the documentation on [readthedocs.io](https://py-omemo.readthedocs.io/), or build/view it locally in the `docs/` directory. To build the docs locally, install the requirements listed in `docs/requirements.txt`, e.g. using `pip install -r docs/requirements.txt`, and then run `make html` from within the `docs/` directory. The documentation can then be found in `docs/_build/html/`.
+Refer to the documentation on [readthedocs.io](https://py-omemo.readthedocs.io/), or build it locally. Additional requirements to build the docs can be installed using `pip install .[docs]`. With all dependencies installed, run `make html` in the `docs/` directory. The documentation can then be found in `docs/_build/html/`.
 
 The `functionality.md` file contains an overview of supported functionality/use cases, mostly targeted at developers.

README.md

@@ -12,22 +12,37 @@
 import os
 import sys
 
-this_file_path = os.path.dirname(os.path.abspath(__file__))
-sys.path.append(os.path.join(this_file_path, "..", "omemo"))
+root_dir_path = os.path.abspath(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
+sys.path.append(os.path.join(root_dir_path, "omemo"))
+
+# -- Project information -----------------------------------------------------------------
 
 from version import __version__ as __version
-from project import project     as __project
 
-# -- Project information -----------------------------------------------------------------
+import tomllib
+from typing import List
+
+with open(os.path.join(root_dir_path, "pyproject.toml"), "rb") as f:
+    __pyproject = tomllib.load(f)
+
+project: str   = __pyproject["project"]["name"]
+author: str    = __pyproject["project"]["authors"][0]["name"]
+copyright: str = f"2025, {author}"
+
+__classifiers: List[str] = __pyproject["project"]["classifiers"]
 
-project   = __project["name"]
-author    = __project["author"]
-copyright = f"{__project['year']}, {__project['author']}"
+__tag: str = "unknown"
+if "Development Status :: 3 - Alpha" in __classifiers:
+    __tag = "alpha"
+if "Development Status :: 4 - Beta" in __classifiers:
+    __tag = "beta"
+if "Development Status :: 5 - Production/Stable" in __classifiers:
+    __tag = "stable"
 
 # The short X.Y version
-version = __version["short"]
+version = __version
 # The full version, including alpha/beta/rc tags
-release = __version["full"]
+release = f"{__version}-{__tag}"
 
 # -- General configuration ---------------------------------------------------------------
 

docs/conf.py

@@ -1,5 +1,4 @@
 from .version import __version__ as __version__
-from .project import project as project
 
 from .backend import (
     Backend as Backend,

docs/requirements.txt

@@ -1183,7 +1183,7 @@ async def set_trust(self, bare_jid: str, identity_key: bytes, trust_level_name:
         """
 
         logging.getLogger(SessionManager.LOG_TAG).debug(
-            f"Setting trust level for identity key {identity_key} to {trust_level_name}."
+            f"Setting trust level for identity key 0x{identity_key.hex()} to {trust_level_name}."
         )
 
         await self.__storage.store(
@@ -2220,7 +2220,7 @@ async def handle_key_exchange(
             plain_key_material
         )
 
-        logging.getLogger(SessionManager.LOG_TAG).debug(f"Message decrypted: {plaintext}")
+        logging.getLogger(SessionManager.LOG_TAG).debug(f"Message decrypted: {plaintext!r}")
 
         # Persist the session following successful decryption
         await backend.store_session(session)