build: Migrate project configuration to pyproject.toml, update CI for newer Python versions, and add project backlog.

Author: hakancelikdev

.github/workflows/docs.yml

@@ -7,13 +7,13 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2.5.0
-      - uses: actions/setup-python@v2.3.3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.13"
           architecture: "x64"
 
-      - name: Install  Dependencies
+      - name: Install Dependencies
         run: |
           python -m pip install --upgrade pip
           python -m pip install .[docs]

.github/workflows/pre-commit.yml

@@ -4,10 +4,10 @@ jobs:
   run:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2.5.0
-      - uses: actions/setup-python@v2.3.3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.13"
           architecture: "x64"
       - name: Install dependencies for pre-commit
         run: |

.github/workflows/pypi.yml

@@ -7,19 +7,19 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2.5.0
-      - uses: actions/setup-python@v2.3.3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.13"
           architecture: "x64"
 
-      - name: Install  Dependencies
+      - name: Install Dependencies
         run: |
           python -m pip install --upgrade pip
           python -m pip install --upgrade build
       - run: python -m build
       - name: Publish package to TestPyPI
-        uses: pypa/gh-action-pypi-publish@v1.5.1
+        uses: pypa/gh-action-pypi-publish@release/v1
         with:
           password: ${{ secrets.TEST_PYPI_API_TOKEN }}
           repository_url: https://test.pypi.org/legacy/
@@ -28,19 +28,19 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2.5.0
-      - uses: actions/setup-python@v2.3.3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.13"
           architecture: "x64"
 
-      - name: Install  Dependencies
+      - name: Install Dependencies
         run: |
           python -m pip install --upgrade pip
           python -m pip install --upgrade build
       - run: python -m build
       - name: Publish a Python distribution to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.5.1
+        uses: pypa/gh-action-pypi-publish@release/v1
         with:
           password: ${{ secrets.PYPI_API_TOKEN }}
           verbose: true

.github/workflows/tests.yml

@@ -6,43 +6,49 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     steps:
-      - uses: actions/[email protected]
+      - uses: actions/checkout@v4
+
+      - name: Install Dependencies for macOS
+        if: runner.os == 'macOS'
+        run: |
+          brew install gettext
+          brew link --force gettext
 
       - name: Set up Python${{ matrix.python-version }}
-        uses: actions/setup-python@v2.3.3
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           architecture: x64
 
-      - name: Install  Dependencies for Python${{ matrix.python-version }}
+      - name: Install Dependencies for Python${{ matrix.python-version }}
         run: |
           python -m pip install --upgrade pip
           python -m pip install tox
       - name: Test with pytest for Python${{ matrix.python-version }}
         run: |
-          tox -e ${{ matrix.python-version }}
+          tox -e py$(echo ${{ matrix.python-version }} | tr -d .)
   coverage:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2.5.0
+      - uses: actions/checkout@v4
 
-      - name: Set up Python3.10
-        uses: actions/setup-python@v2.3.3
+      - name: Set up Python3.13
+        uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.13"
           architecture: x64
 
-      - name: Install  Dependencies
+      - name: Install Dependencies
         run: |
           python -m pip install --upgrade pip
           python -m pip install .[tests]
       - name: Generate coverage report
         run: |
           pytest --cov=./ --cov-report=xml
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3.1.1
+        uses: codecov/codecov-action@v4
         with:
           token: ${{secrets.CODECOV_TOKEN }}
           verbose: true

.pre-commit-config.yaml

@@ -4,12 +4,12 @@
 
 repos:
   - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
+    rev: 7.0.0
     hooks:
       - id: isort
 
   - repo: https://github.com/hakancelikdev/unimport
-    rev: 0.16.0
+    rev: 1.3.0
     hooks:
       - id: unimport
         args:
@@ -25,29 +25,25 @@ repos:
         args:
           - --refactor
 
-  - repo: https://github.com/myint/docformatter
-    rev: v1.6.5
-    hooks:
-      - id: docformatter
-        args: [--in-place]
+
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.3.0
+    rev: v1.19.0
     hooks:
       - id: mypy
         args: [--no-strict-optional, --ignore-missing-imports, --show-error-codes]
         additional_dependencies: [types-toml==0.1.3]
         exclude: "tests/"
 
   - repo: https://github.com/pycqa/flake8
-    rev: 6.0.0
+    rev: 7.3.0
     hooks:
       - id: flake8
         args:
           - --max-line-length=120
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v6.0.0
     hooks:
       - id: end-of-file-fixer
         files: "\\.(py|.txt|.yaml|.json|.in|.md|.toml|.cfg|.html|.yml)$"

docs/tutorial/models.md

@@ -298,7 +298,7 @@ In here, username field will be lowered case.
 
 ### Custom Validation
 We have some built-in validators, but you can also create your own validator.
-For more information, see [Validators](/validators).
+For more information, see [Validators](validators.md).
 
 ```python
 from pydbm import DbmModel, Field

mkdocs.yml

@@ -28,8 +28,8 @@ markdown_extensions:
   - pymdownx.critic
   - pymdownx.details
   - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.highlight
   - pymdownx.inlinehilite
   - pymdownx.keys
@@ -52,7 +52,6 @@ markdown_extensions:
 plugins:
   - search:
       separator: '[\s\-\.]+'
-      prebuild_index: true
   - git-revision-date-localized:
       type: date
       enable_creation_date: true

pyproject.toml

@@ -1,11 +1,65 @@
 # Build system
 [build-system]
-requires = [
-    "setuptools>=65",
-    "wheel>=0.38.4"
-]
+requires = ["setuptools>=65", "wheel>=0.38.4"]
 build-backend = "setuptools.build_meta"
 
+[project]
+name = "pythonic-dbm"
+version = "0.6.1"
+description = "Pydbm is a more pythonic way to use dbm."
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "GPL-3.0"}
+authors = [
+    {name = "Hakan Celik", email = "[email protected]"}
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = []
+
+[project.urls]
+Documentation = "https://pydbm.hakancelik.dev/"
+Issues = "https://github.com/hakancelikdev/pydbm/issues/"
+Changelog = "https://pydbm.hakancelik.dev/changelog"
+
+[project.optional-dependencies]
+tests = [
+    "pytest>=8.3.4",
+    "pytest-cov>=6.0.0",
+]
+docs = [
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.7.0",
+    "mkdocs-markdownextradata-plugin>=0.2.6",
+    "mkdocs-minify-plugin>=0.8.0",
+    "mkdocs-git-revision-date-localized-plugin>=1.5.0",
+    "mike>=2.1.3",
+]
+
+[tool.setuptools]
+include-package-data = true
+zip-safe = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"*" = ["py.typed"]
+
 # Tools
 [tool.pytest.ini_options]
 addopts = "-v"
@@ -19,19 +73,13 @@ skip_gitignore = true
 
 [tool.black]
 line-length = 120
-target-version = ['py39']
+target-version = ['py39', 'py310', 'py311', 'py312', 'py313']
 
 [tool.unimport]
 remove = true
 include_star_import = true
 ignore_init = true
 
-[tool.docformatter]
-recursive = true
-wrap-summaries = 79
-wrap-descriptions = 79
-blank = true
-
 [tool.mypy]
 warn_unused_configs = true
 no_strict_optional = true

setup.cfg

@@ -31,7 +31,7 @@ def __init__(self, field_name: str, field_value: typing.Any, error: ValueError)
         self.error = error
 
     def __str__(self) -> str:
-        return f"Invalid value for {self.field_name}={self.field_value!r}; {self.error}."
+        return f"Invalid value for {self.field_name}={self.field_value!r}, {self.error}."
 
 
 class EmptyModelError(PydbmBaseException):