Merge pull request #11 from bitranox/development

v2.0.0

Author: bitranox

.coveragerc

@@ -7,6 +7,11 @@
 # (boolean, default False): whether to measure branch coverage in addition to statement coverage
 branch  = True
 
+omit =
+    venv/*
+    tests/*
+    setup.py
+
 
 [report]
 # Regexes for lines to exclude from consideration
@@ -29,8 +34,3 @@ exclude_lines=
 
 ignore_errors = True
 
-omit =
-    venv/*
-    tests/*
-    setup.py
-    conf_pathlib3x.py

.docs/README_template.rst

@@ -2,7 +2,7 @@ pathlib3x
 =========
 
 
-Version v1.3.9 as of 2020-10-09 see `Changelog`_
+Version v2.0.0 as of 2022-06-03 see `Changelog`_
 
 
 .. include:: ./badges.rst

.docs/badges.rst

@@ -1,16 +1,18 @@
-|travis_build| |license| |pypi| 
+|build_badge| |license| |pypi| |pypi-downloads| |black|
 
 |codecov| |better_code| |cc_maintain| |cc_issues| |cc_coverage| |snyk|
 
 
-.. |travis_build| image:: https://img.shields.io/travis/bitranox/pathlib3x/master.svg
-   :target: https://travis-ci.org/bitranox/pathlib3x
+
+.. |build_badge| image:: https://github.com/bitranox/pathlib3x/actions/workflows/python-package.yml/badge.svg
+   :target: https://github.com/bitranox/pathlib3x/actions/workflows/python-package.yml
+
 
 .. |license| image:: https://img.shields.io/github/license/webcomics/pywine.svg
    :target: http://en.wikipedia.org/wiki/MIT_License
 
 .. |jupyter| image:: https://mybinder.org/badge_logo.svg
- :target: https://mybinder.org/v2/gh/bitranox/pathlib3x/master?filepath=pathlib3x.ipynb
+   :target: https://mybinder.org/v2/gh/bitranox/pathlib3x/master?filepath=pathlib3x.ipynb
 
 .. for the pypi status link note the dashes, not the underscore !
 .. |pypi| image:: https://img.shields.io/pypi/status/pathlib3x?label=PyPI%20Package
@@ -39,3 +41,7 @@
 
 .. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
+
+.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/pathlib3x
+   :target: https://pypi.org/project/pathlib3x/
+   :alt: PyPI - Downloads

.docs/commandline_help.rst

@@ -1,9 +1,8 @@
-.. code-block:: bash
+.. code-block::
 
    Usage: pathlib3x [OPTIONS] COMMAND [ARGS]...
 
-     backport of pathlib 3.10 to python 3.6, 3.7, 3.8, 3.9 with a few
-     extensions
+     backport of pathlib 3.10 to python 3.6, 3.7, 3.8, 3.9 with a few extensions
 
    Options:
      --version                     Show the version and exit.

.docs/installation.rst

@@ -1,7 +1,7 @@
 - Before You start, its highly recommended to update pip and setup tools:
 
 
-.. code-block:: bash
+.. code-block::
 
     python -m pip --upgrade pip
     python -m pip --upgrade setuptools
@@ -12,14 +12,14 @@
 - to install the latest version from github via pip:
 
 
-.. code-block:: bash
+.. code-block::
 
     python -m pip install --upgrade git+https://github.com/bitranox/pathlib3x.git
 
 
 - include it into Your requirements.txt:
 
-.. code-block:: bash
+.. code-block::
 
     # Insert following line in Your requirements.txt:
     # for the latest Release on pypi:
@@ -34,7 +34,7 @@
 
 - to install the latest development version from source code:
 
-.. code-block:: bash
+.. code-block::
 
     # cd ~
     $ git clone https://github.com/bitranox/pathlib3x.git

.docs/installation_via_pypi.rst

@@ -1,5 +1,5 @@
 - to install the latest release from PyPi via pip (recommended):
 
-.. code-block:: bash
+.. code-block::
 
     python -m pip install --upgrade pathlib3x

.docs/tested_under.rst

@@ -1,3 +1,3 @@
-tested on linux "bionic" with python 3.6, 3.7, 3.8, 3.9-dev, pypy3 - architectures: amd64, ppc64le, s390x, arm64
+tested on recent linux with python 3.6, 3.7, 3.8, 3.9, 3.10, pypy-3.8 - architectures: amd64
 
-`100% (for my added functions) code coverage <https://codecov.io/gh/bitranox/pathlib3x>`_, mypy static type checking ,tested under `Linux, macOS, Windows <https://travis-ci.org/bitranox/pathlib3x>`_, automatic daily builds and monitoring
+`100% (for my added functions) code coverage <https://codecov.io/gh/bitranox/pathlib3x>`_, flake8 style checking ,mypy static type checking ,tested under `Linux, macOS, Windows <https://github.com/bitranox/pathlib3x/actions/workflows/python-package.yml>`_, automatic daily builds and monitoring

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master, development ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master, development ]
+  schedule:
+    - cron: '40 13 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2