Replace pbr with setuptools (#65)

Also adopts src/ layout
pycontribs · Oct 9, 2022 · 94315a6 · 94315a6
1 parent 54bbe8a
commit 94315a6
Show file tree

Hide file tree

Showing 37 changed files with 129 additions and 94 deletions.
diff --git a/.github/workflows/tox.yml b/.github/workflows/tox.yml
@@ -53,7 +53,6 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-          cache: "pip"
       - name: Install tox
         run: |
           python3 -m pip install --upgrade pip

diff --git a/.gitignore b/.gitignore
@@ -28,3 +28,4 @@ test-distribute.sh
 /AUTHORS
 /.pytest_cache
 venv/*
+src/tendo/_version.py
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -4,13 +4,13 @@ repos:
     rev: v2.1.0
     hooks:
       - id: trailing-whitespace
-        exclude: ^tendo/tests/.*\.txt$
+        exclude: ^src/tendo/tests/.*\.txt$
       - id: end-of-file-fixer
-        exclude: ^tendo/tests/.*\.txt$
+        exclude: ^src/tendo/tests/.*\.txt$
       - id: mixed-line-ending
-        exclude: ^tendo/tests/.*\.txt$
+        exclude: ^src/tendo/tests/.*\.txt$
       - id: check-byte-order-marker
-        exclude: ^tendo/tests/.*\.txt$
+        exclude: ^src/tendo/tests/.*\.txt$
       - id: check-executables-have-shebangs
       - id: check-merge-conflict
       - id: check-symlinks

diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/Makefile b/Makefile
diff --git a/README.rst b/README.rst
@@ -33,7 +33,7 @@ not (yet) provided by Python.
 * [transparent Unicode support for text file operations (BOM detection)](https://tendo.readthedocs.org/en/latest/#module-tendo.singleton)
 * [console logging coloring](https://tendo.readthedocs.org/en/latest/#module-tendo.colorer)
 * enable you to use symlinks under windows
-* [python tee implementation](https://tendo.readthedocs.org/en/latest/#module-tendo.colorer) for executing external programs and redirecting their output to both console/file)
+* [python tee implementation](https://tendo.readthedocs.org/en/latest/#module-tendo.colorer) for executing external programs and redirecting their output to both console/file
 * [improved execfile](https://tendo.readthedocs.org/en/latest/#module-tendo.execfile2)
 
 Documentation

diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,10 @@
+---
+codecov:
+  require_ci_to_pass: true
+comment: false
+coverage:
+  status:
+    patch: false
+    project:
+      default:
+        threshold: 0.5%
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,3 +1,15 @@
+[build-system]
+requires = [
+  "setuptools >= 65.4.0", # required by pyproject+setuptools_scm integration
+  "setuptools_scm[toml] >= 3.5.0", # required for "no-local-version" scheme
+  "setuptools_scm_git_archive >= 1.0",
+  "wheel",
+]
+build-backend = "setuptools.build_meta"
+
+[tool.black]
+target-version = ["py38"]
+
 [tool.coverage.run]
 source_pkgs = ["tendo"]
 branch = true
@@ -9,3 +21,11 @@ source = ["src", ".tox/*/site-packages"]
 
 [tool.coverage.report]
 exclude_lines = ["pragma: no cover", "if TYPE_CHECKING:"]
+
+[tool.isort]
+profile = "black"
+add_imports = "from __future__ import annotations"
+
+[tool.setuptools_scm]
+local_scheme = "no-local-version"
+write_to = "src/tendo/_version.py"
diff --git a/pytest.ini b/pytest.ini
@@ -0,0 +1,44 @@
+# spell-checker:ignore filterwarnings norecursedirs optionflags
+[pytest]
+# do not add options here as this will likely break either console runs or IDE
+# integration like vscode or pycharm
+addopts =
+    # https://code.visualstudio.com/docs/python/testing
+    # coverage is re-enabled in `tox.ini`. That approach is safer than
+    # `--no-cov` which prevents activation from tox.ini and which also fails
+    # when plugin is effectively missing.
+    -p no:pytest_cov
+
+doctest_optionflags = ALLOW_UNICODE ELLIPSIS
+filterwarnings =
+    default
+    ignore:.*mode is deprecated:Warning
+    ignore:unclosed file.*:Warning
+    ignore:can't resolve package from.*:Warning
+
+junit_duration_report = call
+# Our github annotation parser from .github/workflows/tox.yml requires xunit1 format. Ref:
+# https://github.com/shyim/junit-report-annotations-action/issues/3#issuecomment-663241378
+junit_family = xunit1
+junit_suite_name = ansible_lint_test_suite
+minversion = 4.6.6
+norecursedirs =
+    build
+    dist
+    docs
+    .cache
+    .eggs
+    .git
+    .github
+    .tox
+    *.egg
+python_files =
+    test_*.py
+    # Ref: https://docs.pytest.org/en/latest/reference.html#confval-python_files
+    # Needed to discover legacy nose test modules:
+    Test*.py
+    # Needed to discover embedded Rule tests
+# Using --pyargs instead of testpath as we embed some tests
+# See: https://github.com/pytest-dev/pytest/issues/6451#issuecomment-687043537
+# testpaths =
+xfail_strict = true
diff --git a/requirements-dev.txt b/requirements-dev.txt
diff --git a/requirements.txt b/requirements.txt
diff --git a/setup.cfg b/setup.cfg
@@ -2,12 +2,13 @@
 name = tendo
 
 author = Sorin Sbarnea
-author-email = [email protected]
+author_email = [email protected]
 maintainer = Sorin Sbarnea
-maintainer-email = [email protected]
+maintainer_email = [email protected]
 summary = A Python library that extends some core functionality
-description-file = README.rst
-home-page = https://github.com/pycontribs/tendo
+long_description = file: README.rst
+long_description_content_type = text/x-rst
+home_page = https://github.com/pycontribs/tendo
 license = BSD
 classifier =
     Development Status :: 5 - Production/Stable
@@ -31,19 +32,44 @@ keywords =
     colorer
     singleton
 
+
 [options]
+use_scm_version = True
 python_requires = >=3.6
+package_dir =
+  = src
+packages = find:
+# Do not use include_package_data as we mention them explicitly.
+# see https://setuptools.pypa.io/en/latest/userguide/datafiles.html
+# include_package_data = True
+zip_safe = False
+install_requires =
+    six
 
-[files]
-packages =
-    tendo
+[options.extras_require]
+test =
+    coverage[toml]>=6.5.0
+    coveralls~=3.3.1
+    pre-commit~=2.20.0
+    pytest-cache~=1.0
+    pytest-cov~=3.0.0
+    pytest-html~=3.1.1
+    pytest-instafail~=0.4.2
+    pytest-xdist~=2.5.0
+    pytest~=7.1.3
+    wheel~=0.37.1
+docs =
+    Sphinx~=5.2.1
+    docutils~=0.19
+    MarkupSafe~=2.1.1
 
-[entry_points]
-pbr.config.drivers =
-    plain = pbr.cfg.driver:Plain
+[options.package_data]
+* =
+  py.typed
+  **/*.txt
 
-[bdist_wheel]
-universal = 1
+[options.packages.find]
+where = src
 
 [build_sphinx]
 source-dir = docs
@@ -58,21 +84,3 @@ enable-extensions = H106,H203,H204,H205,H210,H904
 exclude = __pycache__,build,src,.tox
 ignore = D
 max-line-length=1024
-
-[tool:pytest]
-norecursedirs = . .svn _build tmp* lib/third lib *.egg bin distutils build docs demo
-python_files = *.py
-addopts = -p no:xdist --ignore=setup.py --tb=long --capture=fd -rxX  --maxfail=10 tendo
-# --maxfail=2 -n4
-# -n4              runs up to 4 parallel procs
-# --maxfail=2      fail fast, dude
-# --durations=3    report the top 3 longest tests
-
-# these are important for distributed testing, to speedup their execution we minimize what we sync
-rsyncdirs = . tendo demo docs
-rsyncignore = .hg .git
-filterwarnings =
-    default
-    ignore:.*mode is deprecated:Warning
-    ignore:unclosed file.*:Warning
-    ignore:can't resolve package from.*:Warning
diff --git a/setup.py b/setup.py
diff --git a/tendo/__init__.py → src/tendo/__init__.py b/tendo/__init__.py → src/tendo/__init__.py
@@ -4,12 +4,7 @@
 from __future__ import absolute_import
 import sys
 
-from pbr.version import VersionInfo
-
-
-_v = VersionInfo('tendo').semantic_version()
-__version__ = _v.release_string()
-version_info = _v.version_tuple()
+from ._version import __version__
 
 __author__ = "Sorin Sbarnea"
 __copyright__ = "Copyright 2010-2018, Sorin Sbarnea"

diff --git a/tendo/ansiterm.py → src/tendo/ansiterm.py b/tendo/ansiterm.py → src/tendo/ansiterm.py
diff --git a/tendo/colorer.py → src/tendo/colorer.py b/tendo/colorer.py → src/tendo/colorer.py
diff --git a/tendo/execfile2.py → src/tendo/execfile2.py b/tendo/execfile2.py → src/tendo/execfile2.py
diff --git a/tendo/tests/__init__.py → src/tendo/py.typed b/tendo/tests/__init__.py → src/tendo/py.typed
diff --git a/tendo/singleton.py → src/tendo/singleton.py b/tendo/singleton.py → src/tendo/singleton.py
diff --git a/tendo/tee.py → src/tendo/tee.py b/tendo/tee.py → src/tendo/tee.py
diff --git a/src/tendo/tests/__init__.py b/src/tendo/tests/__init__.py
diff --git a/tendo/tests/assets/full_sample_utf8_bom.txt → ...ndo/tests/assets/full_sample_utf8_bom.txt b/tendo/tests/assets/full_sample_utf8_bom.txt → ...ndo/tests/assets/full_sample_utf8_bom.txt
diff --git a/tendo/tests/assets/sample_ucs2_be.txt → src/tendo/tests/assets/sample_ucs2_be.txt b/tendo/tests/assets/sample_ucs2_be.txt → src/tendo/tests/assets/sample_ucs2_be.txt
diff --git a/tendo/tests/assets/sample_ucs2_le.txt → src/tendo/tests/assets/sample_ucs2_le.txt b/tendo/tests/assets/sample_ucs2_le.txt → src/tendo/tests/assets/sample_ucs2_le.txt
diff --git a/tendo/tests/assets/sample_utf8.txt → src/tendo/tests/assets/sample_utf8.txt b/tendo/tests/assets/sample_utf8.txt → src/tendo/tests/assets/sample_utf8.txt
diff --git a/tendo/tests/assets/sample_utf8_bom.txt → src/tendo/tests/assets/sample_utf8_bom.txt b/tendo/tests/assets/sample_utf8_bom.txt → src/tendo/tests/assets/sample_utf8_bom.txt
diff --git a/tendo/tests/assets/utf8-after-append.txt → src/tendo/tests/assets/utf8-after-append.txt b/tendo/tests/assets/utf8-after-append.txt → src/tendo/tests/assets/utf8-after-append.txt
diff --git a/tendo/tests/assets/utf8-invalid.txt → src/tendo/tests/assets/utf8-invalid.txt b/tendo/tests/assets/utf8-invalid.txt → src/tendo/tests/assets/utf8-invalid.txt
diff --git a/tendo/tests/assets/utf8.txt → src/tendo/tests/assets/utf8.txt b/tendo/tests/assets/utf8.txt → src/tendo/tests/assets/utf8.txt
diff --git a/src/tendo/tests/py.typed b/src/tendo/tests/py.typed
diff --git a/tendo/tests/test_colorer.py → src/tendo/tests/test_colorer.py b/tendo/tests/test_colorer.py → src/tendo/tests/test_colorer.py
diff --git a/tendo/tests/test_execfile2.py → src/tendo/tests/test_execfile2.py b/tendo/tests/test_execfile2.py → src/tendo/tests/test_execfile2.py
diff --git a/tendo/tests/test_singleton.py → src/tendo/tests/test_singleton.py b/tendo/tests/test_singleton.py → src/tendo/tests/test_singleton.py
diff --git a/tendo/tests/test_tee.py → src/tendo/tests/test_tee.py b/tendo/tests/test_tee.py → src/tendo/tests/test_tee.py
diff --git a/tendo/tests/test_unicode.py → src/tendo/tests/test_unicode.py b/tendo/tests/test_unicode.py → src/tendo/tests/test_unicode.py
diff --git a/tendo/unicode.py → src/tendo/unicode.py b/tendo/unicode.py → src/tendo/unicode.py
diff --git a/tox.ini b/tox.ini
@@ -1,9 +1,9 @@
 [tox]
 minversion = 2.3.1
-envlist = lint,docs,{py37,py38,py39,py310}
-skip_missing_interpreters = true
-tox_pyenv_fallback=True
-ignore_errors=False
+envlist = lint,packaging,docs,py
+tox_pyenv_fallback = True
+ignore_errors = False
+isolated_build = True
 
 [testenv]
 sitepackages=False
@@ -29,11 +29,12 @@ setenv =
     COVERAGE_FILE={env:COVERAGE_FILE:{toxworkdir}/.coverage.{envname}}
     COVERAGE_PROCESS_START={toxinidir}/pyproject.toml
 commands=
-    python -m pip -q install -rrequirements-dev.txt -rrequirements.txt
     coverage run -m pytest --color=yes --html={envlogdir}/report.html --self-contained-html
     # --pyargs tendo
 allowlist_externals =
     sh
+deps =
+    --editable .[test]
 
 [testenv:coverage]
 description = Combines and displays coverage results
@@ -42,19 +43,16 @@ commands =
   # needed by codecov github actions:
   coverage xml
   # just for humans running it:
-  coverage report --skip-covered --fail-under=46
+  coverage report --skip-covered --fail-under=43
 deps =
   coverage[toml]>=6.5.0
 
 [testenv:docs]
-basepython=python
 changedir=docs
-deps=
-    sphinx
-    six
-    docutils
 commands=
     sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
+deps =
+    --editable .[docs]
 
 [testenv:lint]
 deps =
@@ -63,11 +61,10 @@ commands=
     python -m pre_commit run --all
 
 [testenv:packaging]
-basepython = python3
 description =
   Build package, verify metadata, install package and assert behavior when ansible is missing.
 deps =
-  build >= 0.7.0, < 0.8.0
+  build >= 0.7.0
   twine
 skip_install = true
 # Ref: https://twitter.com/di_codes/status/1044358639081975813