diff --git a/CHANGES.rst b/CHANGES.rst index 1fad568..db7bc1b 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -7,7 +7,7 @@ Changes * fix Docutils deprecation warning * fix test deprecation warning from Sphinx * use pytest for testing -* add tox support +* switch to PEP-517 build API and metadata 0.3.0 - 2019-07-13 ------------------ diff --git a/Pipfile b/Pipfile index bbdbcef..37d249d 100644 --- a/Pipfile +++ b/Pipfile @@ -8,10 +8,8 @@ sphinx = ">=3" ipcalc = ">=1.99" coverage = "*" twine = "*" -tox = "*" -pytest = "*" path = "*" -tox-pipenv = "*" +pytest = "*" [packages] -jandd-sphinxext-ip = {editable = true,path = "."} +jandd-sphinxext-ip = {path = "."} diff --git a/Pipfile.lock b/Pipfile.lock index 20e67bd..1bd4c35 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -1,7 +1,7 @@ { "_meta": { "hash": { - "sha256": "8deb7ca457ae496bb85ef713e46e2b1d9e876dc9c2bd0214669fc06c1bdd195f" + "sha256": "f2e1dcefcc436449bb6e5b1713d66cb7172c5d7264789d7d74b9526ce85fe950" }, "pipfile-spec": 6, "requires": {}, @@ -75,7 +75,6 @@ "version": "==1.99.0" }, "jandd-sphinxext-ip": { - "editable": true, "path": "." }, "jinja2": { @@ -227,6 +226,10 @@ "markers": "python_version >= '3.5'", "version": "==1.1.4" }, + "unknown": { + "path": ".", + "version": "==0.4.1.dev1+g43ff1cb.d20210102" + }, "urllib3": { "hashes": [ "sha256:19188f96923873c92ccb987120ec4acaa12f0461fa9ce5d3d0772bc965a39e08", @@ -244,13 +247,6 @@ ], "version": "==0.7.12" }, - "appdirs": { - "hashes": [ - "sha256:7d5d0167b2b1ba821647616af46a749d1c653740dd0d2415100fe26e27afdf41", - "sha256:a841dacd6b99318a741b166adb07e19ee71a274450e68237b4650ca1055ab128" - ], - "version": "==1.4.4" - }, "attrs": { "hashes": [ "sha256:31b2eced602aa8423c2aea9c76a724617ed67cf9513173fd3a4f03e3a929c7e6", @@ -414,13 +410,6 @@ "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'", "version": "==3.3.1" }, - "distlib": { - "hashes": [ - "sha256:8c09de2c67b3e7deef7184574fc060ab8a793e7adbb183d942c389c8b13c52fb", - "sha256:edf6116872c863e1aa9d5bb7cb5e05a022c519a4594dc703843343a9ddd9bff1" - ], - "version": "==0.3.1" - }, "docutils": { "hashes": [ "sha256:0c5b78adfbf7762415433f5515cd5c9e762339e23369dbe8000d84a4bf4ab3af", @@ -429,13 +418,6 @@ "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'", "version": "==0.16" }, - "filelock": { - "hashes": [ - "sha256:18d82244ee114f543149c66a6e0c14e9c4f8a1044b5cdaadd0f82159d6a6ff59", - "sha256:929b7d63ec5b7d6b71b0fa5ac14e030b3f70b75747cef1b10da9b879fef15836" - ], - "version": "==3.0.12" - }, "idna": { "hashes": [ "sha256:b307872f855b18632ce0c21c5e45be78c0ea7ae4c15c828c20788b26921eb3f6", @@ -544,14 +526,6 @@ "index": "pypi", "version": "==15.0.1" }, - "pipenv": { - "hashes": [ - "sha256:4ab2f60742184d851ac44b9e1d423afe71dc2ea7a68bde07eb890c8b4ce5a420", - "sha256:8253fe6f9cfb3791a54da8a0571f73c918cb3457dd908684c1800a13a06ec4c1" - ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", - "version": "==2020.11.15" - }, "pkginfo": { "hashes": [ "sha256:a6a4ac943b496745cec21f14f021bbd869d5e9b4f6ec06918cffea5a2f4b9193", @@ -730,22 +704,6 @@ "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'", "version": "==0.10.2" }, - "tox": { - "hashes": [ - "sha256:42ce19ce5dc2f6d6b1fdc5666c476e1f1e2897359b47e0aa3a5b774f335d57c2", - "sha256:4321052bfe28f9d85082341ca8e233e3ea901fdd14dab8a5d3fbd810269fbaf6" - ], - "index": "pypi", - "version": "==3.20.1" - }, - "tox-pipenv": { - "hashes": [ - "sha256:5fe576294be7a5a14ba4bdea729d9c738e6c7d423ab84273c9b106d5b2508999", - "sha256:f51476491b52c22455fe37f31aa1a0c5aa9798d223f19be58dfadcf79e503362" - ], - "index": "pypi", - "version": "==1.10.1" - }, "tqdm": { "hashes": [ "sha256:0cd81710de29754bf17b6fee07bdb86f956b4fa20d3078f02040f83e64309416", @@ -770,22 +728,6 @@ "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4'", "version": "==1.26.2" }, - "virtualenv": { - "hashes": [ - "sha256:54b05fc737ea9c9ee9f8340f579e5da5b09fb64fd010ab5757eb90268616907c", - "sha256:b7a8ec323ee02fb2312f098b6b4c9de99559b462775bc8fe3627a73706603c1b" - ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", - "version": "==20.2.2" - }, - "virtualenv-clone": { - "hashes": [ - "sha256:07e74418b7cc64f4fda987bf5bc71ebd59af27a7bc9e8a8ee9fd54b1f2390a27", - "sha256:665e48dd54c84b98b71a657acb49104c54e7652bce9c1c4f6c6976ed4c827a29" - ], - "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", - "version": "==0.5.4" - }, "webencodings": { "hashes": [ "sha256:a0af1213f3c2226497a97e2b3aa01a7e4bee4f403f95be16fc9acd2947514a78", diff --git a/README.rst b/README.rst index da40be4..8f0d853 100644 --- a/README.rst +++ b/README.rst @@ -15,6 +15,13 @@ The extension is developed in a git repository that can be cloned by running:: git clone https://git.dittberner.info/jan/sphinxext-ip.git +Running test +------------ + +To install all dependencies and run the tests use:: + + pipenv install --dev + pipenv run pytest Contributors ============ diff --git a/pyproject.toml b/pyproject.toml index d90de47..a139a71 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,11 +1,9 @@ [build-system] -requires = [ "setuptools >= 35.0.2", "wheel >= 0.29.0" ] +requires = [ + "setuptools >= 35.0.2", + "setuptools_scm[toml] >= 5.0", + "wheel >= 0.29.0" +] +build-backend = "setuptools.build_meta" -[tool.tox] -legacy_tox_ini = """ -[testenv] -deps = - pytest - path -commands = pytest -""" +[tool.setuptools_scm] diff --git a/setup.cfg b/setup.cfg index 8938096..fff1fcd 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,13 +1,37 @@ -[egg_info] -tag_build = dev -tag_date = true - -[aliases] -release = egg_info -RDb '' - [coverage:run] branch = true source = jandd.sphinxext.ip [coverage:report] show_missing = true + +[metadata] +name = jandd.sphinxext.ip +description = IP address extension for Sphinx +long_description = file: README.rst, CHANGES.rst +long_description_content_type = text/rst +url = https://pypi.org/project/jandd.sphinxext.ip/ +author = Jan Dittberner +author_email = jan@dittberner.info +keywords = sphinx, extension, IP +license = GPLv3+ +license_file = COPYING +platforms = any +classifiers = + Development Status :: 5 - Production/Stable + Framework :: Sphinx :: Extension + License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+) + Programming Language :: Python :: 3 + Topic :: Documentation + Topic :: Internet + +[options] +zip_safe = False +include_package_data = True +packages = find: +install_requires = + Sphinx >= 3 + ipcalc >= 1.99 +namespace_packages = + jandd + jandd.sphinxext diff --git a/setup.py b/setup.py deleted file mode 100644 index 73b3e54..0000000 --- a/setup.py +++ /dev/null @@ -1,40 +0,0 @@ -#!/usr/bin/env python3 - -from setuptools import find_packages, setup - -version = "0.4.0" - -with open("README.rst") as readme: - description = readme.read() + "\n\n" - -with open("CHANGES.rst") as changes: - description += changes.read() - -requires = ["Sphinx>=3", "ipcalc>=1.99"] - - -setup( - author="Jan Dittberner", - author_email="jan@dittberner.info", - description="IP address extension for Sphinx", - long_description=description, - include_package_data=True, - install_requires=requires, - keywords="sphinx extension IP", - license="GPLv3+", - url="https://pypi.python.org/pypi/jandd.sphinxext.ip", - name="jandd.sphinxext.ip", - namespace_packages=["jandd", "jandd.sphinxext"], - packages=find_packages(), - platforms="any", - version=version, - zip_safe=False, - classifiers=[ - "Development Status :: 4 - Beta", - "Framework :: Sphinx :: Extension", - "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", - "Programming Language :: Python :: 3", - "Topic :: Documentation", - "Topic :: Internet", - ], -)