Move most of package configuration to pyproject.toml - closes #704

Author: Grzegorz Śliwiński

MANIFEST.in

@@ -1,3 +1,2 @@
-include *.rst *.py
-include pytest_postgresql/py.typed
+include *.rst *.py pytest_postgresql/py.typed
 recursive-include pytest_postgresql *.py

newsfragments/704.misc.rst

@@ -0,0 +1 @@
+Move most of package configuration to pyproject.toml

pyproject.toml

@@ -1,12 +1,74 @@
+[project]
+name = "pytest-postgresql"
+version = "4.1.1"
+description = "Postgresql fixtures and fixture factories for Pytest."
+readme = "README.rst"
+keywords = ["tests", "pytest", "fixture", "postgresql"]
+license = {file = "LICENSE"}
+authors = [
+    {name = "Grzegorz Śliwiński", email = "fizyk+pypi@fizyk.dev"}
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Testing",
+    "Framework :: Pytest",
+]
+dependencies = [
+    "pytest >= 6.2",
+    "port-for >= 0.6.0",
+    "mirakuru",
+    "setuptools",
+]
+requires-python = ">= 3.8"
+
+[project.urls]
+"Source" = "https://github.com/ClearcodeHQ/pytest-postgresql"
+"Bug Tracker" = "https://github.com/ClearcodeHQ/pytest-postgresql/issues"
+"Changelog" = "https://github.com/ClearcodeHQ/pytest-postgresql/blob/v4.1.1/CHANGES.rst"
+
+[project.entry-points."pytest11"]
+pytest_redis = "pytest_postgresql.plugin"
+
 [build-system]
-requires = ["setuptools >= 40.6.0", "wheel"]
+requires = ["setuptools >= 61.0.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools]
+zip-safe = true
+
+[tool.setuptools.packages.find]
+include = ["pytest_postgresql*"]
+exclude = ["tests*"]
+namespaces = false
+
+[tool.pytest.ini_options]
+xfail_strict=true
+addopts = "--max-worker-restart=0 --showlocals --verbose --cov"
+testpaths = "tests"
+pytester_example_dir = "tests/examples"
+norecursedirs = "examples"
+
 [tool.black]
 line-length = 100
 target-version = ['py39']
 include = '.*\.pyi?$'
 
+[tool.pydocstyle]
+ignore = "D203,D212"
+
 [tool.towncrier]
 directory = "newsfragments"
 single_file=true

pytest_postgresql/compat.py

@@ -27,7 +27,7 @@
 
 def check_for_psycopg() -> None:
     """
-    Function checks whether psycopg was imported.
+    Check whether psycopg was imported.
 
     Raises ImportError if not.
     """

pytest_postgresql/config.py

@@ -1,9 +1,12 @@
+"""Plugin's configuration."""
 from typing import Optional, TypedDict, Any, List
 
 from pytest import FixtureRequest
 
 
 class PostgresqlConfigDict(TypedDict):
+    """Typed Config dictionary."""
+
     exec: str
     host: str
     port: Optional[str]

pytest_postgresql/factories/noprocess.py

@@ -28,7 +28,7 @@
 
 
 def xdistify_dbname(dbname: str) -> str:
-    """Modified the database name depending on the presence and usage of xdist."""
+    """Modify the database name depending on the presence and usage of xdist."""
     xdist_worker = os.getenv("PYTEST_XDIST_WORKER")
     if xdist_worker:
         return f"{dbname}{xdist_worker}"

pytest_postgresql/janitor.py

@@ -106,7 +106,7 @@ def _terminate_connection(cur: cursor, dbname: str) -> None:
 
     def load(self, load: Union[Callable, str]) -> None:
         """
-        Loads data into a database.
+        Load data into a database.
 
         Either runs a passed loader if it's callback,
         or runs predefined loader if it's sql file.
@@ -157,6 +157,7 @@ def connect() -> connection:
             conn.close()
 
     def __enter__(self: DatabaseJanitorType) -> DatabaseJanitorType:
+        """Initialize Database Janitor."""
         self.init()
         return self
 
@@ -166,4 +167,5 @@ def __exit__(
         exc_val: Optional[BaseException],
         exc_tb: Optional[TracebackType],
     ) -> None:
+        """Exit from Database janitor context cleaning after itself."""
         self.drop()

pytest_postgresql/retry.py

@@ -1,4 +1,4 @@
-"""Small retry callable in case of specific error occurred"""
+"""Small retry callable in case of specific error occurred."""
 
 from datetime import datetime, timedelta
 from time import sleep

pytest_postgresql/sql.py

@@ -1,10 +1,11 @@
+"""SQL Loader function."""
 from typing import Any
 
 from pytest_postgresql.compat import psycopg
 
 
 def loader(sql_filename: str, **kwargs: Any) -> None:
-    """Database loader for sql files"""
+    """Database loader for sql files."""
     db_connection = psycopg.connect(**kwargs)
     with open(sql_filename, "r") as _fd:
         with db_connection.cursor() as cur:

setup.cfg

@@ -1,66 +1,3 @@
-[metadata]
-name = pytest-postgresql
-version = 4.1.1
-url = https://github.com/ClearcodeHQ/pytest-postgresql
-description = Postgresql fixtures and fixture factories for Pytest.
-long_description = file: README.rst, CHANGES.rst
-long_description_content_type = text/x-rst
-keywords = tests, py.test, pytest, fixture, postgresql
-license = LGPLv3+
-maintainer = Grzegorz Śliwiński
-maintainer_email = fizyk+pypi@fizyk.net.pl
-classifiers =
-    Development Status :: 5 - Production/Stable
-    Environment :: Web Environment
-    Intended Audience :: Developers
-    License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
-    Natural Language :: English
-    Operating System :: OS Independent
-    Programming Language :: Python
-    Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.8
-    Programming Language :: Python :: 3.9
-    Programming Language :: Python :: 3.10
-    Programming Language :: Python :: 3.11
-    Programming Language :: Python :: 3 :: Only
-    Topic :: Software Development :: Libraries :: Python Modules
-    Topic :: Software Development :: Testing
-    Framework :: Pytest
-
-[options]
-zip_safe = False
-include_package_data = True
-python_requires = >= 3.8
-packages = pytest_postgresql
-install_requires =
-    pytest>=6.2.0
-    port-for
-    mirakuru>=2.3.0
-    setuptools
-
-[options.entry_points]
-pytest11 =
-    pytest_postgresql = pytest_postgresql.plugin
-
-[options.package_data]
-pytest_postgresql = py.typed
-
-[options.extras_require]
-tests =
-    pytest-cov
-    pytest-xdist
-
 [flake8]
 max-line-length = 100
 exclude = docs/*,build/*,venv/*
-
-[pydocstyle]
-ignore = D203,D212
-match = '(?!docs|build|venv).*\.py'
-
-[tool:pytest]
-addopts = --max-worker-restart=0 --showlocals --verbose --cov pytest_postgresql --cov tests
-testpaths = tests
-xfail_strict = true
-pytester_example_dir = tests/examples
-norecursedirs=examples