v2.1.3

--------- 2023-07-13: - require minimum python 3.8 - remove python 3.7 tests - introduce PEP517 packaging standard - introduce pyproject.toml build-system - remove setup.cfg - remove setup.py - update black config - clean ./tests/test_cli.py - update black config - remove travis config - remove bettercodehub config - do not upload .egg files to pypi.org - update github actions : checkout@v3 and setup-python@v4 - remove "better code" badges - remove python 3.6 tests - adding python 3.11 tests - update pypy tests to 3.9
bitranox · Jul 13, 2023 · 9519041 · 9519041
1 parent 541eaf3
commit 9519041
Show file tree

Hide file tree

Showing 29 changed files with 293 additions and 693 deletions.
diff --git a/.bettercodehub.yml b/.bettercodehub.yml
diff --git a/.docs/README_template.rst b/.docs/README_template.rst
@@ -2,7 +2,7 @@ igittigitt
 ==========
 
 
-Version v2.1.2 as of 2022-06-25 see `Changelog`_
+Version v2.1.3 as of 2023-07-13 see `Changelog`_
 
 
 .. include:: ./badges.rst
@@ -11,10 +11,10 @@ Version v2.1.2 as of 2022-06-25 see `Changelog`_
 
 ----
 
-automated tests, Travis Matrix, Documentation, Badges, etc. are managed with `PizzaCutter <https://github
+automated tests, Github Actions, Documentation, Badges, etc. are managed with `PizzaCutter <https://github
 .com/bitranox/PizzaCutter>`_ (cookiecutter on steroids)
 
-Python version required: 3.6.0 or newer
+Python version required: 3.8.0 or newer
 
 .. include:: ./tested_under.rst
 

diff --git a/.docs/badges.rst b/.docs/badges.rst
@@ -1,6 +1,6 @@
 |build_badge| |license| |jupyter| |pypi| |pypi-downloads| |black|
 
-|codecov| |better_code| |cc_maintain| |cc_issues| |cc_coverage| |snyk|
+|codecov| |cc_maintain| |cc_issues| |cc_coverage| |snyk|
 
 
 
@@ -21,9 +21,6 @@
 .. |codecov| image:: https://img.shields.io/codecov/c/github/bitranox/igittigitt
    :target: https://codecov.io/gh/bitranox/igittigitt
 
-.. |better_code| image:: https://bettercodehub.com/edge/badge/bitranox/igittigitt?branch=master
-   :target: https://bettercodehub.com/results/bitranox/igittigitt
-
 .. |cc_maintain| image:: https://img.shields.io/codeclimate/maintainability-percentage/bitranox/igittigitt?label=CC%20maintainability
    :target: https://codeclimate.com/github/bitranox/igittigitt/maintainability
    :alt: Maintainability
@@ -36,7 +33,7 @@
    :target: https://codeclimate.com/github/bitranox/igittigitt/test_coverage
    :alt: Code Coverage
 
-.. |snyk| image:: https://img.shields.io/snyk/vulnerabilities/github/bitranox/igittigitt
+.. |snyk| image:: https://snyk.io/test/github/bitranox/igittigitt/badge.svg
    :target: https://snyk.io/test/github/bitranox/igittigitt
 
 .. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg

diff --git a/.docs/installation.rst b/.docs/installation.rst
@@ -32,14 +32,14 @@
     python -m pip install --upgrade -r /<path>/requirements.txt
 
 
-- to install the latest development version from source code:
+- to install the latest development version, including test dependencies from source code:
 
 .. code-block::
 
     # cd ~
     $ git clone https://github.com/bitranox/igittigitt.git
     $ cd igittigitt
-    python setup.py install
+    python -m pip install -e .[test]
 
 
 .. include:: ./installation_via_makefile.rst
diff --git a/.docs/installation_via_pypi.rst b/.docs/installation_via_pypi.rst
@@ -3,3 +3,11 @@
 .. code-block::
 
     python -m pip install --upgrade igittigitt
+
+
+- to install the latest release from PyPi via pip, including test dependencies:
+
+.. code-block::
+
+    python -m pip install --upgrade igittigitt[test]
+
diff --git a/.docs/tested_under.rst b/.docs/tested_under.rst
@@ -1,3 +1,3 @@
-tested on recent linux with python 3.6, 3.7, 3.8, 3.9, 3.10, pypy-3.8 - architectures: amd64
+tested on recent linux with python 3.8, 3.9, 3.10, 3.11, pypy-3.9 - architectures: amd64
 
-`100% code coverage <https://codecov.io/gh/bitranox/igittigitt>`_, flake8 style checking ,mypy static type checking ,tested under `Linux, macOS, Windows <https://github.com/bitranox/igittigitt/actions/workflows/python-package.yml>`_, automatic daily builds and monitoring
+`100% code coverage <https://codeclimate.com/github/bitranox/igittigitt/test_coverage>`_, flake8 style checking ,mypy static type checking ,tested under `Linux, macOS, Windows <https://github.com/bitranox/igittigitt/actions/workflows/python-package.yml>`_, automatic daily builds and monitoring
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,5 @@
+[flake8]
+max_line_length = 160
+ignore = E123, E203, E402, F401, F403, F405, W503
+exclude = .git, __pycache__, build, dist, .eggs, .hg, .mypy_cache, .nox, .tox, .venv, _build, buck-out
+max-complexity = 20
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -71,15 +71,15 @@ jobs:
       matrix:
         include:
           # https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software
+          # https://github.com/actions/setup-python/blob/main/docs/advanced-usage.md#available-versions-of-python-and-pypy
 
           - os: windows-latest
-            python-version: "3.10"
+            python-version: "3.11"
             env:
               cEXPORT: "SET"
               BUILD_DOCS: "False"
-              DEPLOY_SDIST: "False"
-              DEPLOY_WHEEL: "False"
-              DEPLOY_TEST: "False"
+              BUILD: "False"
+              BUILD_TEST: "False"
               MYPY_DO_TESTS: "True"
               # Setup tests
               DO_SETUP_INSTALL: "True"
@@ -89,87 +89,69 @@ jobs:
 
 
           - os: ubuntu-latest
-            python-version: "3.6"
-            env:
-              BUILD_DOCS: "False"
-              DEPLOY_SDIST: "True"
-              DEPLOY_WHEEL: "True"
-              DEPLOY_TEST: "True"
-              MYPY_DO_TESTS: "True"
-              DO_SETUP_INSTALL: "True"
-              DO_SETUP_INSTALL_TEST: "False"
-              DO_CLI_TEST: "True"
-
-          - os: ubuntu-latest
-            python-version: "3.7"
+            python-version: "3.8"
             env:
               BUILD_DOCS: "False"
-              DEPLOY_SDIST: "True"
-              DEPLOY_WHEEL: "True"
-              DEPLOY_TEST: "True"
+              BUILD: "True"  
+              BUILD_TEST: "True"
               MYPY_DO_TESTS: "True"
               DO_SETUP_INSTALL: "True"
-              DO_SETUP_INSTALL_TEST: "False"
+              DO_SETUP_INSTALL_TEST: "True"
               DO_CLI_TEST: "True"
 
           - os: ubuntu-latest
-            python-version: "3.8"
+            python-version: "3.9"
             env:
               BUILD_DOCS: "False"
-              DEPLOY_SDIST: "True"
-              DEPLOY_WHEEL: "True"
-              DEPLOY_TEST: "True"
+              BUILD: "True"  
+              BUILD_TEST: "True"
               MYPY_DO_TESTS: "True"
               DO_SETUP_INSTALL: "True"
-              DO_SETUP_INSTALL_TEST: "False"
+              DO_SETUP_INSTALL_TEST: "True"
               DO_CLI_TEST: "True"
 
           - os: ubuntu-latest
-            python-version: "3.9"
+            python-version: "3.10"
             env:
               BUILD_DOCS: "False"
-              DEPLOY_SDIST: "True"
-              DEPLOY_WHEEL: "True"
-              DEPLOY_TEST: "True"
+              BUILD: "True"  
+              BUILD_TEST: "True"
               MYPY_DO_TESTS: "True"
               DO_SETUP_INSTALL: "True"
-              DO_SETUP_INSTALL_TEST: "False"
+              DO_SETUP_INSTALL_TEST: "True"
               DO_CLI_TEST: "True"
 
           - os: ubuntu-latest
-            python-version: "3.10"
+            python-version: "3.11"
             env:
               BUILD_DOCS: "True"
-              DEPLOY_SDIST: "True"
-              DEPLOY_WHEEL: "True"
-              DEPLOY_TEST: "True"
+              BUILD: "True"  
+              BUILD_TEST: "True"
               MYPY_DO_TESTS: "True"
               DO_SETUP_INSTALL: "True"
               DO_SETUP_INSTALL_TEST: "True"
               DO_CLI_TEST: "True"
 
           - os: ubuntu-latest
-            python-version: "pypy-3.8"
+            python-version: "pypy-3.9"
             env:
               BUILD_DOCS: "False"
-              DEPLOY_SDIST: "True"
-              DEPLOY_WHEEL: "True"
-              DEPLOY_TEST: "True"
+              BUILD: "True"  
+              BUILD_TEST: "True"
               MYPY_DO_TESTS: "False"
               DO_SETUP_INSTALL: "True"
-              DO_SETUP_INSTALL_TEST: "False"
+              DO_SETUP_INSTALL_TEST: "True"
               DO_CLI_TEST: "True"
 
           - os: macos-latest
-            python-version: "3.10"
+            python-version: "3.11"
             env:
               cPREFIX: ""               # prefix before commands - used for wine, there the prefix is "wine"
               cPYTHON: "python3"        # command to launch python interpreter (it's different on macOS, there we need python3)
               cPIP: "python3 -m pip"    # command to launch pip (it's different on macOS, there we need pip3)
               BUILD_DOCS: "False"
-              DEPLOY_SDIST: "True"
-              DEPLOY_WHEEL: "True"
-              DEPLOY_TEST: "True"
+              BUILD: "True"
+              BUILD_TEST: "True"
               MYPY_DO_TESTS: "True"
               # Setup tests
               DO_SETUP_INSTALL: "True"
@@ -185,7 +167,8 @@ jobs:
     - uses: actions/checkout@v3
 
     - name: Setting up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
+      # see: https://github.com/actions/setup-python
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}