Skip to content

Commit c74987e

Browse files
committed
v1.2.9
-------- 2023-07-21: - require minimum python 3.8 - remove python 3.7 tests - introduce PEP517 packaging standard - introduce pyproject.toml build-system - remove mypy.ini - remove pytest.ini - remove setup.cfg - remove setup.py - remove .bettercodehub.yml - remove .travis.yml - update black config - clean ./tests/test_cli.py - add codeql badge - move 3rd_party_stubs outside the src directory to ``./.3rd_party_stubs`` - add pypy 3.10 tests - add python 3.12-dev tests
1 parent 89abf00 commit c74987e

35 files changed

+740
-686
lines changed

lib_platform/3rd_party_stubs/readme.txt renamed to .3rd_party_stubs/readme.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
put 3rd party stubs in this directory needed to pass mypy on travis.
1+
put 3rd party stubs in this directory needed to pass mypy on Github Actions.
22

3-
in the travis.yml the MYPYPATH is set to this directory.
3+
in the Github Actions the MYPYPATH is set to this directory.
44

55
for local testing, put the *.pyi Files into another central directory and set the mypy path accordingly.
66
the reason for that is, that a certain *.pyi have to be only found once by mypy, otherwise it will throw an error.
@@ -17,6 +17,6 @@ the module "external_test" is used in project_a, and project_b, and package_a im
1717
-- project_B ------- package_b_dir --- 3rd_party_stubs --- external_test.pyi
1818

1919

20-
for travis test of project_A we need to set the MYPYPATH to .../projects/project_A/package_a_dir/3rd_party_stubs
20+
for travis test of project_A we need to set the MYPYPATH to .../projects/project_A/3rd_party_stubs
2121

2222
for local tests, we need to set the MYPYPATH to .../projects/stub_directory , not to find external_test.pyi twice.

.bettercodehub.yml

Lines changed: 0 additions & 6 deletions
This file was deleted.

.coveragerc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77
# (boolean, default False): whether to measure branch coverage in addition to statement coverage
88
branch = True
99

10+
omit =
11+
venv/*
12+
tests/*
13+
setup.py
14+
1015

1116
[report]
1217
# Regexes for lines to exclude from consideration
@@ -29,8 +34,3 @@ exclude_lines=
2934

3035
ignore_errors = True
3136

32-
omit =
33-
venv/*
34-
tests/*
35-
setup.py
36-
conf_lib_platform.py

.docs/README_template.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ lib_platform
22
============
33

44

5-
Version v1.2.7 as of 2020-10-09 see `Changelog`_
5+
Version v1.2.9 as of 2023-07-21 see `Changelog`_
66

77

88
.. include:: ./badges.rst
@@ -11,10 +11,10 @@ Version v1.2.7 as of 2020-10-09 see `Changelog`_
1111

1212
----
1313

14-
automated tests, Travis Matrix, Documentation, Badges, etc. are managed with `PizzaCutter <https://github
14+
automated tests, Github Actions, Documentation, Badges, etc. are managed with `PizzaCutter <https://github
1515
.com/bitranox/PizzaCutter>`_ (cookiecutter on steroids)
1616

17-
Python version required: 3.6.0 or newer
17+
Python version required: 3.8.0 or newer
1818

1919
.. include:: ./tested_under.rst
2020

.docs/badges.rst

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
1-
|travis_build| |license| |jupyter| |pypi|
1+
|build_badge| |codeql| |license| |jupyter| |pypi|
2+
|pypi-downloads| |black| |codecov| |cc_maintain| |cc_issues| |cc_coverage| |snyk|
23

3-
|codecov| |better_code| |cc_maintain| |cc_issues| |cc_coverage| |snyk|
44

55

6-
.. |travis_build| image:: https://img.shields.io/travis/bitranox/lib_platform/master.svg
7-
:target: https://travis-ci.org/bitranox/lib_platform
6+
.. |build_badge| image:: https://github.com/bitranox/lib_platform/actions/workflows/python-package.yml/badge.svg
7+
:target: https://github.com/bitranox/lib_platform/actions/workflows/python-package.yml
8+
9+
10+
.. |codeql| image:: https://github.com/bitranox/lib_platform/actions/workflows/codeql-analysis.yml/badge.svg?event=push
11+
:target: https://github.com//bitranox/lib_platform/actions/workflows/codeql-analysis.yml
812

913
.. |license| image:: https://img.shields.io/github/license/webcomics/pywine.svg
1014
:target: http://en.wikipedia.org/wiki/MIT_License
1115

1216
.. |jupyter| image:: https://mybinder.org/badge_logo.svg
13-
:target: https://mybinder.org/v2/gh/bitranox/lib_platform/master?filepath=lib_platform.ipynb
17+
:target: https://mybinder.org/v2/gh/bitranox/lib_platform/master?filepath=lib_platform.ipynb
1418

1519
.. for the pypi status link note the dashes, not the underscore !
1620
.. |pypi| image:: https://img.shields.io/pypi/status/lib-platform?label=PyPI%20Package
@@ -19,9 +23,6 @@
1923
.. |codecov| image:: https://img.shields.io/codecov/c/github/bitranox/lib_platform
2024
:target: https://codecov.io/gh/bitranox/lib_platform
2125

22-
.. |better_code| image:: https://bettercodehub.com/edge/badge/bitranox/lib_platform?branch=master
23-
:target: https://bettercodehub.com/results/bitranox/lib_platform
24-
2526
.. |cc_maintain| image:: https://img.shields.io/codeclimate/maintainability-percentage/bitranox/lib_platform?label=CC%20maintainability
2627
:target: https://codeclimate.com/github/bitranox/lib_platform/maintainability
2728
:alt: Maintainability
@@ -34,8 +35,12 @@
3435
:target: https://codeclimate.com/github/bitranox/lib_platform/test_coverage
3536
:alt: Code Coverage
3637

37-
.. |snyk| image:: https://img.shields.io/snyk/vulnerabilities/github/bitranox/lib_platform
38+
.. |snyk| image:: https://snyk.io/test/github/bitranox/lib_platform/badge.svg
3839
:target: https://snyk.io/test/github/bitranox/lib_platform
3940

4041
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
4142
:target: https://github.com/psf/black
43+
44+
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/lib-platform
45+
:target: https://pypi.org/project/lib-platform/
46+
:alt: PyPI - Downloads

.docs/commandline_help.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. code-block:: bash
1+
.. code-block::
22
33
Usage: lib_platform [OPTIONS] COMMAND [ARGS]...
44

.docs/installation.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
- Before You start, its highly recommended to update pip and setup tools:
22

33

4-
.. code-block:: bash
4+
.. code-block::
55
66
python -m pip --upgrade pip
77
python -m pip --upgrade setuptools
@@ -12,14 +12,14 @@
1212
- to install the latest version from github via pip:
1313

1414

15-
.. code-block:: bash
15+
.. code-block::
1616
1717
python -m pip install --upgrade git+https://github.com/bitranox/lib_platform.git
1818
1919
2020
- include it into Your requirements.txt:
2121

22-
.. code-block:: bash
22+
.. code-block::
2323
2424
# Insert following line in Your requirements.txt:
2525
# for the latest Release on pypi:
@@ -32,14 +32,14 @@
3232
python -m pip install --upgrade -r /<path>/requirements.txt
3333
3434
35-
- to install the latest development version from source code:
35+
- to install the latest development version, including test dependencies from source code:
3636

37-
.. code-block:: bash
37+
.. code-block::
3838
3939
# cd ~
4040
$ git clone https://github.com/bitranox/lib_platform.git
4141
$ cd lib_platform
42-
python setup.py install
42+
python -m pip install -e .[test]
4343
4444
4545
.. include:: ./installation_via_makefile.rst

.docs/installation_via_pypi.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
- to install the latest release from PyPi via pip (recommended):
22

3-
.. code-block:: bash
3+
.. code-block::
44
55
python -m pip install --upgrade lib_platform
6+
7+
8+
- to install the latest release from PyPi via pip, including test dependencies:
9+
10+
.. code-block::
11+
12+
python -m pip install --upgrade lib_platform[test]
13+

.docs/tested_under.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
tested on linux "bionic" with python 3.6, 3.7, 3.8, 3.9-dev, pypy3 - architectures: amd64, ppc64le, s390x, arm64
1+
tested on recent linux with python 3.8, 3.9, 3.10, 3.11, 3.12-dev, pypy-3.9, pypy-3.10 - architectures: amd64
22

3-
`100% code coverage <https://codecov.io/gh/bitranox/lib_platform>`_, flake8 style checking ,mypy static type checking ,tested under `Linux, macOS, Windows <https://travis-ci.org/bitranox/lib_platform>`_, automatic daily builds and monitoring
3+
`100% code coverage <https://codeclimate.com/github/bitranox/lib_platform/test_coverage>`_, flake8 style checking ,mypy static type checking ,tested under `Linux, macOS, Windows <https://github.com/bitranox/lib_platform/actions/workflows/python-package.yml>`_, automatic daily builds and monitoring

.flake8

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[flake8]
2+
max_line_length = 160
3+
ignore = E123, E203, E402, F401, F403, F405, W503
4+
exclude = .git, __pycache__, build, dist, .eggs, .hg, .mypy_cache, .nox, .tox, .venv, _build, buck-out
5+
max-complexity = 20

0 commit comments

Comments
 (0)