Rework project to use pyproject.toml (#236)

.github/workflows/main.yml

@@ -30,7 +30,7 @@ jobs:
       - name: Update pip and install dev requirements
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements-dev.txt
+          pip install '.[dev]'
 
       - name: Test
         run: tox

MANIFEST.in

@@ -1,6 +1,5 @@
 include *.rst
 include pyproject.toml
-include requirements-dev.txt
 include Makefile
 include LICENSE
 include .readthedocs.yaml

Makefile

@@ -34,11 +34,3 @@ docs:  ## Runs cog and builds Sphinx docs
 	make -C docs/ clean
 	make -C docs/ doctest
 	make -C docs/ html
-
-.PHONY: checkrot
-checkrot:  ## Check package rot for dev dependencies
-	python -m venv ./tmpvenv/
-	./tmpvenv/bin/pip install -U pip
-	./tmpvenv/bin/pip install -r requirements-dev.txt
-	./tmpvenv/bin/pip list -o
-	rm -rf ./tmpvenv/

README.rst

@@ -54,17 +54,13 @@ Run::
 
 Some configuration environments require additional dependencies::
 
+
     # For INI support
     $ pip install 'everett[ini]'
 
     # for YAML support
     $ pip install 'everett[yaml]'
 
-Additionally, if you want to use the Sphinx extension to document
-your configuration, you need to add Sphinx::
-
-    # to use the Sphinx extension
-    $ pip install 'everett[sphinx]'
 
 Quick start
 ===========

docs/conf.py

@@ -57,7 +57,7 @@
 # The short X.Y version.
 version = everett.__version__
 # The full version with the release date.
-release = everett.__version__ + " " + everett.__releasedate__
+release = everett.__version__
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"

docs/dev.rst

@@ -20,4 +20,4 @@ Create and activate a virtualenvironment::
 
 Install Everett and dev requirements into virtual environment::
 
-    $ pip install -r requirements-dev.txt
+    $ pip install -e '.[dev,ini,yaml,sphinx]'

pyproject.toml

@@ -1,3 +1,62 @@
+[project]
+name = "everett"
+description = "Configuration library for Python applications"
+version = "3.3.0"
+readme = "README.rst"
+keywords = ["conf", "config", "configuration", "ini", "env", "yaml"]
+authors = [{name = "Will Kahn-Greene"}]
+license = {text = "MPLv2"}
+requires-python = ">=3.8"
+dependencies = []
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+urls.Homepage = "https://everett.readthedocs.io/"
+urls.Source = "https://github.com/willkg/everett/"
+urls.Issues = "https://github.com/willkg/everett/issues"
+
+[project.optional-dependencies]
+sphinx = [
+    "sphinx",
+]
+ini = [
+    "configobj",
+]
+yaml = [
+    "PyYAML",
+]
+dev = [
+    "check-manifest",
+    "cogapp",
+    "mypy",
+    "pytest",
+    "ruff",
+    "tox",
+    "tox-gh-actions",
+    "twine",
+    "types-PyYAML",
+    "Sphinx==7.2.6; python_version > '3.8'",
+    "Sphinx==6.2.1; python_version <= '3.8'",
+    "sphinx_rtd_theme",
+]
+
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+
 [tool.ruff]
 # Enable pycodestyle (E), pyflakes (F), and bugbear (B) rules
 select = ["E", "F", "B"]
@@ -43,13 +102,13 @@ legacy_tox_ini = """
 [tox]
 envlist =
     py38
+    py38-doctest
+    py38-lint
+    py38-typecheck
     py39
     py310
     py311
     py312
-    py38-doctest
-    py38-lint
-    py38-typecheck
 
 [gh-actions]
 python =
@@ -60,19 +119,18 @@ python =
     3.12: py312
 
 [testenv]
-deps = -rrequirements-dev.txt
+extras = dev,ini,sphinx,yaml
 commands = pytest {posargs} tests/
 
 [testenv:py38-doctest]
-deps = -rrequirements-dev.txt
 commands = pytest --doctest-modules src/
 
 [testenv:py38-lint]
 basepython = python3.8
 changedir = {toxinidir}
 commands =
-    ruff format --check setup.py tests docs examples
-    ruff check src setup.py tests docs examples
+    ruff format --check tests docs examples
+    ruff check src tests docs examples
 
 [testenv:py38-typecheck]
 basepython = python3.8

src/everett/__init__.py

@@ -5,16 +5,17 @@
 
 """Everett is a Python library for configuration."""
 
+from importlib.metadata import (
+    version as importlib_version,
+    PackageNotFoundError,
+)
 from typing import Callable, List, Union
 
 
-__author__ = "Will Kahn-Greene"
-__email__ = "willkg@mozilla.com"
-
-# yyyymmdd
-__releasedate__ = "20231106"
-# x.y.z or x.y.z.dev0
-__version__ = "3.3.0"
+try:
+    __version__ = importlib_version("everett")
+except PackageNotFoundError:
+    __version__ = "unknown"
 
 
 __all__ = [