From 5e60d18edcc46091dfad10b5ce7ba9c1f36dbe57 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Tue, 27 Dec 2022 10:56:32 +0200 Subject: [PATCH] Convert setup.cfg to pyproject.toml --- .flake8 | 2 + .github/workflows/test.yml | 2 +- .gitignore | 170 ++++++++++++++++++++++++++++++++++--- .pre-commit-config.yaml | 11 ++- pyproject.toml | 71 +++++++++++++++- setup.cfg | 65 -------------- setup.py | 4 +- tox.ini | 4 +- 8 files changed, 240 insertions(+), 89 deletions(-) create mode 100644 .flake8 delete mode 100644 setup.cfg diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000..f4546ad --- /dev/null +++ b/.flake8 @@ -0,0 +1,2 @@ +[flake8] +max_line_length = 88 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 9f458ed..1ac5a3a 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -22,7 +22,7 @@ jobs: with: python-version: ${{ matrix.python-version }} cache: pip - cache-dependency-path: setup.cfg + cache-dependency-path: pyproject.toml - name: Install Linux dependencies if: startsWith(matrix.os, 'ubuntu') diff --git a/.gitignore b/.gitignore index dccc5cf..68bc17f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,16 +1,160 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ .coverage -.DS_Store -.eggs -.testmondata -.tox -*.egg-info* +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations *.mo *.pot -*.py[co] -*.sw[po] -build -dist -docs/_build* -htmlcov -site -tags + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e0a7444..894dc29 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -65,17 +65,16 @@ repos: additional_dependencies: [pytest, types-freezegun, types-setuptools] args: [--strict] - - repo: https://github.com/asottile/setup-cfg-fmt - rev: v2.2.0 - hooks: - - id: setup-cfg-fmt - args: [--max-py-version=3.11, --include-version-classifiers] - - repo: https://github.com/tox-dev/pyproject-fmt rev: 0.4.1 hooks: - id: pyproject-fmt + - repo: https://github.com/abravalheri/validate-pyproject + rev: v0.10.1 + hooks: + - id: validate-pyproject + - repo: https://github.com/tox-dev/tox-ini-fmt rev: 0.5.2 hooks: diff --git a/pyproject.toml b/pyproject.toml index 1dd2e5c..3d7347e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,12 +1,79 @@ [build-system] build-backend = "setuptools.build_meta" requires = [ - "setuptools>=42", - "setuptools_scm[toml]>=3.4", + "setuptools>=61.2", + "setuptools_scm[toml]>=6.2", ] +[project] +name = "humanize" +description = "Python humanize utilities" +readme = "README.md" +keywords = [ + "humanize time size", +] +license = {text = "MIT"} +maintainers = [{name = "Hugo van Kemenade"}] +authors = [{name = "Jason Moiron", email = "jmoiron@jmoiron.net"}] +requires-python = ">=3.7" +dependencies = [ + 'importlib-metadata; python_version < "3.8"', +] +dynamic = [ + "version", +] +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Intended Audience :: Developers", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: Implementation :: CPython", + "Programming Language :: Python :: Implementation :: PyPy", + "Topic :: Text Processing", + "Topic :: Text Processing :: General", +] +[project.optional-dependencies] +tests = [ + "freezegun", + "pytest", + "pytest-cov", +] + +[project.urls] +Documentation = "https://python-humanize.readthedocs.io/" +Funding = "https://tidelift.com/subscription/pkg/pypi-humanize?utm_source=pypi-humanize&utm_medium=pypi" +Homepage = "https://github.com/python-humanize/humanize" +"Issue tracker" = "https://github.com/python-humanize/humanize/issues" +"Release notes" = "https://github.com/python-humanize/humanize/releases" +Source = "https://github.com/python-humanize/humanize" + + [tool.black] target_version = ["py37"] +[tool.hatch] +version.source = "vcs" + +[tool.isort] +profile = "black" + +[tool.pydocstyle] +convention = "google" + +[tool.pytest.ini_options] +addopts = "--color=yes" + +[tool.setuptools.packages.find] +where = ["src"] +namespaces = false + [tool.setuptools_scm] local_scheme = "no-local-version" diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 157c2bf..0000000 --- a/setup.cfg +++ /dev/null @@ -1,65 +0,0 @@ -[metadata] -name = humanize -description = Python humanize utilities -long_description = file: README.md -long_description_content_type = text/markdown -url = https://github.com/python-humanize/humanize -author = Jason Moiron -author_email = jmoiron@jmoiron.net -maintainer = Hugo van Kemenade -license = MIT -license_file = LICENCE -classifiers = - Development Status :: 5 - Production/Stable - Intended Audience :: Developers - License :: OSI Approved :: MIT License - Operating System :: OS Independent - Programming Language :: Python - Programming Language :: Python :: 3 - Programming Language :: Python :: 3 :: Only - Programming Language :: Python :: 3.7 - Programming Language :: Python :: 3.8 - Programming Language :: Python :: 3.9 - Programming Language :: Python :: 3.10 - Programming Language :: Python :: 3.11 - Programming Language :: Python :: Implementation :: CPython - Programming Language :: Python :: Implementation :: PyPy - Topic :: Text Processing - Topic :: Text Processing :: General -keywords = humanize time size -project_urls = - Source=https://github.com/python-humanize/humanize - Issue tracker=https://github.com/python-humanize/humanize/issues - Funding=https://tidelift.com/subscription/pkg/pypi-humanize?utm_source=pypi-humanize&utm_medium=pypi - Documentation=https://python-humanize.readthedocs.io/ - Release notes=https://github.com/python-humanize/humanize/releases - -[options] -packages = find: -install_requires = - importlib-metadata;python_version < '3.8' -python_requires = >=3.7 -include_package_data = True -package_dir = =src -zip_safe = False - -[options.packages.find] -where = src - -[options.extras_require] -tests = - freezegun - pytest - pytest-cov - -[flake8] -max_line_length = 88 - -[pydocstyle] -convention = google - -[tool:isort] -profile = black - -[tool:pytest] -addopts = --color=yes diff --git a/setup.py b/setup.py index 6068493..f0e2d5b 100644 --- a/setup.py +++ b/setup.py @@ -1,3 +1,5 @@ from setuptools import setup -setup() +setup( + setup_requires=["setuptools_scm"], +) diff --git a/tox.ini b/tox.ini index c6e41e9..be1d692 100644 --- a/tox.ini +++ b/tox.ini @@ -1,6 +1,8 @@ [tox] envlist = - py{py3, 311, 310, 39, 38, 37} + docs + lint + py{py3, 312, 311, 310, 39, 38, 37} [testenv] passenv =