From caf27e820f41bec3dd9c24ba156d24208d00a2eb Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Sun, 18 Jul 2021 19:46:32 +0200 Subject: [PATCH 01/11] Bump version to v0.2.1. --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 8f942dd..65a8b1c 100644 --- a/setup.py +++ b/setup.py @@ -48,7 +48,7 @@ setuptools.setup( name=projectName, - version="0.2.0", + version="0.2.1", author="Patrick Lehmann", author_email="Paebbels@gmail.com", From 228635d186e4b0a1aa6fe614536dd00cd1b756ce Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Mon, 19 Jul 2021 20:17:57 +0200 Subject: [PATCH 02/11] Added PR template. --- .github/pull_request_template.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..7a345ae --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,8 @@ +# New Features +* tbd + +# Changes +* tbd + +# Bug Fixes +* tbd From 8bb9eeae387a1f02837ec609588a87b7b7c73887 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Mon, 19 Jul 2021 20:19:15 +0200 Subject: [PATCH 03/11] Added Dependabot configuration. --- .github/dependabot.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..0896e81 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,15 @@ +version: 2 +updates: +- package-ecosystem: pip + directory: "/" + target-branch: dev + commit-message: + prefix: "[Dependabot]" + labels: + - Dependencies + assignees: + - Paebbels + reviewers: + - Paebbels + schedule: + interval: daily From bea81bc2e613e12b5406dc68f238281000a83359 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Mon, 19 Jul 2021 21:01:23 +0200 Subject: [PATCH 04/11] Improved .coveragerc file. --- .coveragerc | 17 ----------------- tests/.coveragerc | 5 +++++ 2 files changed, 5 insertions(+), 17 deletions(-) delete mode 100644 .coveragerc diff --git a/.coveragerc b/.coveragerc deleted file mode 100644 index ea6c0b6..0000000 --- a/.coveragerc +++ /dev/null @@ -1,17 +0,0 @@ -[run] -branch = true -omit = - *site-packages* - -[report] -skip_covered = True -skip_empty = True -exclude_lines = - if __name__ == "__main__": - raise NotImplementedError - -[html] -directory = .cov - -[xml] -output = coverage.xml diff --git a/tests/.coveragerc b/tests/.coveragerc index 0ebb5bd..ea6c0b6 100644 --- a/tests/.coveragerc +++ b/tests/.coveragerc @@ -1,9 +1,14 @@ [run] branch = true +omit = + *site-packages* [report] skip_covered = True skip_empty = True +exclude_lines = + if __name__ == "__main__": + raise NotImplementedError [html] directory = .cov From a9365697bcbece13a4f45800e199210e600bf148 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Mon, 19 Jul 2021 21:01:33 +0200 Subject: [PATCH 05/11] Updated requirements. --- doc/requirements.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index c1c3dc9..2473aa8 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,16 +1,16 @@ -r ../requirements.txt # Enforce latest version on ReadTheDocs -sphinx>=3.2.1 +sphinx>=4.1.1 # Sphinx Themes -sphinx-rtd-theme>=0.5.0 +sphinx-rtd-theme>=0.5.2 # Sphinx Extenstions sphinx_fontawesome>=0.0.6 -sphinx_autodoc_typehints>=1.11.0 +sphinx_autodoc_typehints>=1.12.0 # changelog>=0.3.5 # BuildTheDocs Extensions (mostly patched Sphinx extensions) # Enforce newer version on ReadTheDocs (currently using 2.3.1) -Pygments>=2.6.1 +Pygments>=2.9.0 From d93c411267bbffc87e7a88e47c68d3a7f049ec84 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Mon, 19 Jul 2021 21:24:50 +0200 Subject: [PATCH 06/11] Added '@export' decorator. --- pyGenericPath/URL.py | 15 +++++++++++---- pyGenericPath/__init__.py | 7 +++++++ requirements.txt | 1 + 3 files changed, 19 insertions(+), 4 deletions(-) diff --git a/pyGenericPath/URL.py b/pyGenericPath/URL.py index 75aa906..1d3e436 100644 --- a/pyGenericPath/URL.py +++ b/pyGenericPath/URL.py @@ -33,16 +33,19 @@ # SPDX-License-Identifier: Apache-2.0 # ============================================================================ # -from re import compile as re_compile -from typing import Dict +from re import compile as re_compile +from typing import Dict -from flags import Flags +from flags import Flags +from pydecor import export -from . import RootMixIn, ElementMixIn, PathMixIn +from . import RootMixIn, ElementMixIn, PathMixIn regExp = re_compile(r"^(?:(?P\w+)://)?(?:(?P(?:\w+|\.)+)(?:\:(?P\d+))?)?(?P[^?#]*)(?:\?(?P[^#]+))?(?:#(?P.+))?$") + +@export class Protocols(Flags): """Enumeration of supported URL schemes.""" @@ -54,6 +57,7 @@ class Protocols(Flags): FILE = 32 #: Local files +@export class Host(RootMixIn): """Represents a hostname (including the port number) in a URL.""" @@ -82,10 +86,12 @@ def __str__(self): return result +@export class Element(ElementMixIn): """Derived class for the URL context.""" +@export class Path(PathMixIn): """Represents a path in a URL.""" @@ -98,6 +104,7 @@ def Parse(cls, path: str, root=None): return super().Parse(path, root, cls, Element) +@export class URL(): """Represents a URL including scheme, host, credentials, path, query and fragment.""" diff --git a/pyGenericPath/__init__.py b/pyGenericPath/__init__.py index 99e5321..feccf9a 100644 --- a/pyGenericPath/__init__.py +++ b/pyGenericPath/__init__.py @@ -35,7 +35,10 @@ # from typing import List +from pydecor import export + +@export class Base(): """Base-class for all pyGenericPath path elements""" @@ -47,6 +50,7 @@ def __init__(self, parent): self._parent = parent +@export class RootMixIn(Base): """Mixin-class for root elements in a path system.""" @@ -54,6 +58,7 @@ def __init__(self): super().__init__(None) +@export class ElementMixIn(Base): """Mixin-class for elements in a path system.""" @@ -67,6 +72,7 @@ def __str__(self): return self._elementName +@export class PathMixIn(): """Mixin-class for a path.""" @@ -116,5 +122,6 @@ def Parse(cls, path: str, root, pathCls, elementCls): return pathCls(elements, isAbsolute) +@export class SystemMixIn(): """Mixin-class for a path system.""" diff --git a/requirements.txt b/requirements.txt index baee69f..9cf0a58 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,2 @@ py-flags>=1.1.4 +pydecor>=2.0.1 From 8d760e434b9e508c3e195a48d9213899fd3f3a83 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Mon, 19 Jul 2021 23:38:04 +0200 Subject: [PATCH 07/11] Reviewed dependencies. --- doc/Dependencies.rst | 113 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 112 insertions(+), 1 deletion(-) diff --git a/doc/Dependencies.rst b/doc/Dependencies.rst index 5b0bcaa..6446a84 100644 --- a/doc/Dependencies.rst +++ b/doc/Dependencies.rst @@ -1,4 +1,115 @@ +.. _dependency: + Dependencies ############ -* py-flags +.. |img-pyGenericPath-lib-status| image:: https://img.shields.io/librariesio/release/pypi/pyGenericPath + :alt: Libraries.io status for latest release + :height: 22 + :target: https://libraries.io/github/Paebbels/pyGenericPath +.. |img-pyGenericPath-req-status| image:: https://img.shields.io/requires/github/Paebbels/pyGenericPath + :alt: Requires.io + :height: 22 + :target: https://requires.io/github/Paebbels/pyGenericPath/requirements/?branch=master + ++------------------------------------------+------------------------------------------+ +| `Libraries.io `_ | `Requires.io `_ | ++==========================================+==========================================+ +| |img-pyGenericPath-lib-status| | |img-pyGenericPath-req-status| | ++------------------------------------------+------------------------------------------+ + +.. _dependency-package: + +pyGenericPath Package (Mandatory) +******************************** + +.. rubric:: Manually Installing Package Requirements + +Use the :file:`requirements.txt` file to install all dependencies via ``pip3`` +or install the package directly from PyPI (see :ref:`INSTALL`). + +.. code-block:: shell + + pip3 install -U -r requirements.txt + + +.. rubric:: Dependency List + ++----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| **Package** | **Version** | **License** | **Dependencies** | ++================================================================+=============+===========================================================================================+======================================================================================================================================================================+ +| `py-flags `__ | ≥1.1.4 | `MIT `__ | * `dictionaries `__ (`MIT `__) | ++----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `pydecor `__ | ≥2.0.1 | `MIT `__ | * `dill `__ (`BSD 3-clause `__) | +| | | | * `six `__ (`MIT `__) | ++----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + +.. _dependency-testing: + +Unit Testing / Coverage (Optional) +********************************** + +Additional Python packages needed for testing and code coverage collection. +These packages are only needed for developers or on a CI server, thus +sub-dependencies are not evaluated further. + + +.. rubric:: Manually Installing Test Requirements + +Use the :file:`tests/requirements.txt` file to install all dependencies via +``pip3``. The file will recursively install the mandatory dependencies too. + +.. code-block:: shell + + pip3 install -U -r tests/requirements.txt + + +.. rubric:: Dependency List + ++-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ +| **Package** | **Version** | **License** | **Dependencies** | ++===========================================================+=============+========================================================================================+======================+ +| `pytest `__ | ≥6.2.4 | `MIT `__ | *Not yet evaluated.* | ++-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ +| `pytest-cov `__ | ≥2.12.1 | `MIT `__ | *Not yet evaluated.* | ++-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ +| `Coverage `__ | ≥5.5 | `Apache License, 2.0 `__ | *Not yet evaluated.* | ++-----------------------------------------------------------+-------------+----------------------------------------------------------------------------------------+----------------------+ + + +.. _dependency-documentation: + +Sphinx Documentation (Optional) +******************************* + +Additional Python packages needed for documentation generation. These packages +are only needed for developers or on a CI server, thus sub-dependencies are not +evaluated further. + + +.. rubric:: Manually Installing Documentation Requirements + +Use the :file:`doc/requirements.txt` file to install all dependencies via +``pip3``. The file will recursively install the mandatory dependencies too. + +.. code-block:: shell + + pip3 install -U -r doc/requirements.txt + + +.. rubric:: Dependency List + ++-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+ +| **Package** | **Version** | **License** | **Dependencies** | ++=================================================================================================+==============+==========================================================================================================+======================+ +| `Sphinx `__ | ≥4.1.1 | `BSD 3-Clause `__ | *Not yet evaluated.* | ++-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+ +| `sphinx_btd_theme `__ | ≥0.5.2 | `MIT `__ | *Not yet evaluated.* | ++-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+ +| !! `sphinx_fontawesome `__ | ≥0.0.6 | `GPL 2.0 `__ | *Not yet evaluated.* | ++-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+ +| `sphinx_autodoc_typehints `__ | ≥1.12.0 | `MIT `__ | *Not yet evaluated.* | ++-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+ +| `Pygments `__ | ≥2.9.0 | `BSD 2-Clause `__ | *Not yet evaluated.* | ++-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+----------------------+ From 92adb0baaf915eafdbbbad0ad124fe5dad8a8c75 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Tue, 20 Jul 2021 19:59:18 +0200 Subject: [PATCH 08/11] Fixed 'find_packages' in setup.py. --- doc/Dependencies.rst | 2 +- setup.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/Dependencies.rst b/doc/Dependencies.rst index 6446a84..f6da75e 100644 --- a/doc/Dependencies.rst +++ b/doc/Dependencies.rst @@ -21,7 +21,7 @@ Dependencies .. _dependency-package: pyGenericPath Package (Mandatory) -******************************** +********************************* .. rubric:: Manually Installing Package Requirements diff --git a/setup.py b/setup.py index 65a8b1c..93b2796 100644 --- a/setup.py +++ b/setup.py @@ -67,7 +67,7 @@ }, # download_url="", - packages=setuptools.find_packages(), + packages=setuptools.find_packages(exclude=["tests", "tests.*"]), classifiers=[ "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", From 1c2293ed62a8ebaffa2df06df3d2cc02fa2b134a Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Tue, 20 Jul 2021 23:05:13 +0200 Subject: [PATCH 09/11] Updated Shields in README. --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 157c22a..d485d4e 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,22 @@ [![Sourcecode on GitHub](https://img.shields.io/badge/Paebbels-pyGenericPath-323131.svg?logo=github&longCache=true)](https://github.com/Paebbels/pyGenericPath) -[![License](https://img.shields.io/badge/code%20license-Apache%20License%2C%202.0-lightgrey?logo=GitHub)](LICENSE.md) +[![Sourcecode License](https://img.shields.io/pypi/l/pyGenericPath?logo=GitHub&label=code%20license)](LICENSE.md) [![GitHub tag (latest SemVer incl. pre-release)](https://img.shields.io/github/v/tag/Paebbels/pyGenericPath?logo=GitHub&include_prereleases)](https://github.com/Paebbels/pyGenericPath/tags) [![GitHub release (latest SemVer incl. including pre-releases)](https://img.shields.io/github/v/release/Paebbels/pyGenericPath?logo=GitHub&include_prereleases)](https://github.com/Paebbels/pyGenericPath/releases/latest) -[![GitHub release date](https://img.shields.io/github/release-date/Paebbels/pyGenericPath?logo=GitHub&)](https://github.com/Paebbels/pyGenericPath/releases) -[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Paebbels/pyGenericPath/Test,%20Coverage%20and%20Release?label=Workflow&logo=GitHub)](https://github.com/Paebbels/pyGenericPath/actions?query=workflow%3A%22Test%2C+Coverage+and+Release%22) -[![PyPI](https://img.shields.io/pypi/v/pyGenericPath?logo=PyPI)](https://pypi.org/project/pyGenericPath/) -![PyPI - Status](https://img.shields.io/pypi/status/pyGenericPath?logo=PyPI) -![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyGenericPath?logo=PyPI) -[![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/pypi/pyGenericPath)](https://github.com/Paebbels/pyGenericPath/network/dependents) -[![Libraries.io status for latest release](https://img.shields.io/librariesio/release/pypi/pyGenericPath)](https://libraries.io/github/Paebbels/pyGenericPath) -[![Requires.io](https://img.shields.io/requires/github/Paebbels/pyGenericPath)](https://requires.io/github/Paebbels/pyGenericPath/requirements/?branch=master) +[![GitHub release date](https://img.shields.io/github/release-date/Paebbels/pyGenericPath?logo=GitHub&)](https://github.com/Paebbels/pyGenericPath/releases) +[![Dependents (via libraries.io)](https://img.shields.io/librariesio/dependents/pypi/pyGenericPath?logo=librariesdotio)](https://github.com/Paebbels/pyGenericPath/network/dependents) +[![GitHub Workflow - Build and Test Status](https://img.shields.io/github/workflow/status/Paebbels/pyGenericPath/Unit%20Testing,%20Coverage%20Collection,%20Package,%20Release,%20Documentation%20and%20Publish?label=Pipeline&logo=GitHub%20Actions&logoColor=FFFFFF)](https://github.com/Paebbels/pyGenericPath/actions/workflows/Pipeline.yml) [![Codacy - Quality](https://img.shields.io/codacy/grade/ed13ac3d1be0405ea2de08a588bfd325?logo=Codacy)](https://www.codacy.com/manual/Paebbels/pyGenericPath) [![Codacy - Coverage](https://img.shields.io/codacy/coverage/ed13ac3d1be0405ea2de08a588bfd325?logo=Codacy)](https://www.codacy.com/manual/Paebbels/pyGenericPath) [![Codecov - Branch Coverage](https://img.shields.io/codecov/c/github/Paebbels/pyGenericPath?logo=Codecov)](https://codecov.io/gh/Paebbels/pyGenericPath) -[![Libraries.io SourceRank](https://img.shields.io/librariesio/sourcerank/pypi/pyGenericPath)](https://libraries.io/github/Paebbels/pyGenericPath/sourcerank) -[![Read the Docs](https://img.shields.io/readthedocs/pygenericpath)](https://pyGenericPath.readthedocs.io/en/latest/) +[![Libraries.io SourceRank](https://img.shields.io/librariesio/sourcerank/pypi/pyGenericPath?logo=librariesdotio)](https://libraries.io/github/Paebbels/pyGenericPath/sourcerank) +[![PyPI](https://img.shields.io/pypi/v/pyGenericPath?logo=PyPI&logoColor=FBE072)](https://pypi.org/project/pyGenericPath/) +![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyGenericPath?logo=PyPI&logoColor=FBE072) +![PyPI - Status](https://img.shields.io/pypi/status/pyGenericPath?logo=PyPI&logoColor=FBE072) +[![Libraries.io status for latest release](https://img.shields.io/librariesio/release/pypi/pyGenericPath?logo=librariesdotio)](https://libraries.io/github/Paebbels/pyGenericPath) +[![Requires.io](https://img.shields.io/requires/github/Paebbels/pyGenericPath)](https://requires.io/github/Paebbels/pyGenericPath/requirements/?branch=main) +[![Read the Docs](https://img.shields.io/readthedocs/pygenericpath?label=ReadTheDocs&logo=readthedocs)](https://pyGenericPath.readthedocs.io/) +[![Documentation License](https://img.shields.io/badge/doc%20license-CC--BY%204.0-green?logo=readthedocs)](LICENSE.md) +[![Documentation - Read Now!](https://img.shields.io/badge/doc-read%20now%20%E2%9E%94-blueviolet?logo=readthedocs)](https://pyGenericPath.readthedocs.io/) # pyGenericPath From 5560c19862f52500c6823619879247d46649c06e Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Fri, 23 Jul 2021 00:51:43 +0200 Subject: [PATCH 10/11] Reworked Shields for index.rst. --- README.md | 8 +++--- doc/index.rst | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 83 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d485d4e..588f092 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Sourcecode License](https://img.shields.io/pypi/l/pyGenericPath?logo=GitHub&label=code%20license)](LICENSE.md) [![GitHub tag (latest SemVer incl. pre-release)](https://img.shields.io/github/v/tag/Paebbels/pyGenericPath?logo=GitHub&include_prereleases)](https://github.com/Paebbels/pyGenericPath/tags) [![GitHub release (latest SemVer incl. including pre-releases)](https://img.shields.io/github/v/release/Paebbels/pyGenericPath?logo=GitHub&include_prereleases)](https://github.com/Paebbels/pyGenericPath/releases/latest) -[![GitHub release date](https://img.shields.io/github/release-date/Paebbels/pyGenericPath?logo=GitHub&)](https://github.com/Paebbels/pyGenericPath/releases) +[![GitHub release date](https://img.shields.io/github/release-date/Paebbels/pyGenericPath?logo=GitHub)](https://github.com/Paebbels/pyGenericPath/releases) [![Dependents (via libraries.io)](https://img.shields.io/librariesio/dependents/pypi/pyGenericPath?logo=librariesdotio)](https://github.com/Paebbels/pyGenericPath/network/dependents) [![GitHub Workflow - Build and Test Status](https://img.shields.io/github/workflow/status/Paebbels/pyGenericPath/Unit%20Testing,%20Coverage%20Collection,%20Package,%20Release,%20Documentation%20and%20Publish?label=Pipeline&logo=GitHub%20Actions&logoColor=FFFFFF)](https://github.com/Paebbels/pyGenericPath/actions/workflows/Pipeline.yml) [![Codacy - Quality](https://img.shields.io/codacy/grade/ed13ac3d1be0405ea2de08a588bfd325?logo=Codacy)](https://www.codacy.com/manual/Paebbels/pyGenericPath) @@ -26,13 +26,13 @@ A generic path implementation to derive domain specific path libraries. ## Contributors * [Patrick Lehmann](https://github.com/Paebbels) (Maintainer) +* [and more...](https://github.com/Paebbels/pyGenericPath/graphs/contributors) ## License -This Python package (source code) is licensed under [Apache License 2.0](LICENSE.md). - - +This Python package (source code) licensed under [Apache License 2.0](LICENSE.md). +The accompanying documentation is licensed under [Creative Commons - Attribution 4.0 (CC-BY 4.0)](doc/Doc-License.rst). ------------------------- diff --git a/doc/index.rst b/doc/index.rst index b264468..b92fb0f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,3 +1,82 @@ +.. |img-pyGenericPath-github| image:: https://img.shields.io/badge/Paebbels-pyGenericPath-323131.svg?logo=github&longCache=true + :alt: Sourcecode on GitHub + :height: 22 + :target: https://github.com/Paebbels/pyGenericPath +.. |img-pyGenericPath-codelicense| image:: https://img.shields.io/pypi/l/pyGenericPath?logo=GitHub&label=code%20license + :alt: Sourcecode License + :height: 22 +.. |img-pyGenericPath-tag| image:: https://img.shields.io/github/v/tag/Paebbels/pyGenericPath?logo=GitHub&include_prereleases + :alt: GitHub tag (latest SemVer incl. pre-release) + :height: 22 + :target: https://github.com/Paebbels/pyGenericPath/tags +.. |img-pyGenericPath-release| image:: https://img.shields.io/github/v/release/Paebbels/pyGenericPath?logo=GitHub&include_prereleases + :alt: GitHub release (latest SemVer incl. including pre-releases + :height: 22 + :target: https://github.com/Paebbels/pyGenericPath/releases/latest +.. |img-pyGenericPath-date| image:: https://img.shields.io/github/release-date/Paebbels/pyGenericPath?logo=GitHub + :alt: GitHub release date + :height: 22 + :target: https://github.com/Paebbels/pyGenericPath/releases +.. |img-pyGenericPath-lib-dep| image:: https://img.shields.io/librariesio/dependents/pypi/pyGenericPath?logo=librariesdotio + :alt: Dependents (via libraries.io) + :height: 22 + :target: https://github.com/Paebbels/pyGenericPath/network/dependents +.. |img-pyGenericPath-gha-pipeline| image:: https://img.shields.io/github/workflow/status/Paebbels/pyGenericPath/Unit%20Testing,%20Coverage%20Collection,%20Package,%20Release,%20Documentation%20and%20Publish?label=Pipeline&logo=GitHub%20Actions&logoColor=FFFFFF + :alt: GitHub Workflow - Build and Test Status + :height: 22 + :target: https://github.com/Paebbels/pyGenericPath/actions/workflows/Pipeline.yml +.. |img-pyGenericPath-codacy-quality| image:: https://img.shields.io/codacy/grade/ed13ac3d1be0405ea2de08a588bfd325?logo=Codacy + :alt: Codacy - Quality + :height: 22 + :target: https://www.codacy.com/manual/Paebbels/pyGenericPath +.. |img-pyGenericPath-codacy-coverage| image:: https://img.shields.io/codacy/coverage/ed13ac3d1be0405ea2de08a588bfd325?logo=Codacy + :alt: Codacy - Line Coverage + :height: 22 + :target: https://www.codacy.com/manual/Paebbels/pyGenericPath +.. |img-pyGenericPath-codecov-coverage| image:: https://img.shields.io/codecov/c/github/Paebbels/pyGenericPath?logo=Codecov + :alt: Codecov - Branch Coverage + :height: 22 + :target: https://codecov.io/gh/Paebbels/pyGenericPath +.. |img-pyGenericPath-lib-rank| image:: https://img.shields.io/librariesio/sourcerank/pypi/pyGenericPath?logo=librariesdotio + :alt: Libraries.io SourceRank + :height: 22 + :target: https://libraries.io/github/Paebbels/pyGenericPath/sourcerank +.. |img-pyGenericPath-pypi-tag| image:: https://img.shields.io/pypi/v/pyGenericPath?logo=PyPI&logoColor=FBE072 + :alt: PyPI - Tag + :height: 22 + :target: https://pypi.org/project/pyGenericPath/ +.. |img-pyGenericPath-pypi-python| image:: https://img.shields.io/pypi/pyversions/pyGenericPath?logo=PyPI&logoColor=FBE072 + :alt: PyPI - Python Version + :height: 22 +.. |img-pyGenericPath-pypi-status| image:: https://img.shields.io/pypi/status/pyGenericPath?logo=PyPI&logoColor=FBE072 + :alt: PyPI - Status + :height: 22 +.. |img-pyGenericPath-lib-status| image:: https://img.shields.io/librariesio/release/pypi/pyGenericPath?logo=librariesdotio + :alt: Libraries.io status for latest release + :height: 22 + :target: https://libraries.io/github/Paebbels/pyGenericPath +.. |img-pyGenericPath-req-status| image:: https://img.shields.io/requires/github/Paebbels/pyGenericPath + :alt: Requires.io + :height: 22 + :target: https://requires.io/github/Paebbels/pyGenericPath/requirements/?branch=master +.. |img-pyGenericPath-rtd| image:: https://img.shields.io/readthedocs/pygenericpath?label=ReadTheDocs&logo=readthedocs + :alt: Read the Docs + :height: 22 + :target: https://pyGenericPath.readthedocs.io/ +.. |img-pyGenericPath-doclicense| image:: https://img.shields.io/badge/doc%20license-CC--BY%204.0-green?logo=readthedocs + :alt: Documentation License + :height: 22 + :target: LICENSE.md +.. |img-pyGenericPath-doc| image:: https://img.shields.io/badge/doc-read%20now%20%E2%9E%94-blueviolet?logo=readthedocs + :alt: Documentation - Read Now! + :height: 22 + :target: https://pyGenericPath.readthedocs.io/ + +|img-pyGenericPath-github| |img-pyGenericPath-codelicense| |img-pyGenericPath-tag| |img-pyGenericPath-release| |img-pyGenericPath-date| |img-pyGenericPath-lib-dep| |br| +|img-pyGenericPath-gha-pipeline| |img-pyGenericPath-codacy-quality| |img-pyGenericPath-codacy-coverage| |img-pyGenericPath-codecov-coverage| |img-pyGenericPath-lib-rank| |br| +|img-pyGenericPath-pypi-tag| |img-pyGenericPath-pypi-python| |img-pyGenericPath-pypi-status| |img-pyGenericPath-lib-status| |img-pyGenericPath-req-status| |br| +|img-pyGenericPath-rtd| |img-pyGenericPath-doclicense| |img-pyGenericPath-doc| + .. code-block:: ____ _ ____ _ _ From d6485db84f310bf4ca3bc3f123a71a82b1d28bc9 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Fri, 23 Jul 2021 01:11:17 +0200 Subject: [PATCH 11/11] Added doc license note in ReST. --- doc/index.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/doc/index.rst b/doc/index.rst index b92fb0f..90d52f3 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -118,13 +118,23 @@ Contributors ************ * `Patrick Lehmann `_ (Maintainer) +* `and more... `__ License ******* -This library is licensed under **Apache License 2.0**. +.. only:: html + + This Python package (source code) is licensed under `Apache License 2.0 `__. |br| + The accompanying documentation is licensed under `Creative Commons - Attribution 4.0 (CC-BY 4.0) `__. + +.. only:: latex + + This Python package (source code) is licensed under **Apache License 2.0**. |br| + The accompanying documentation is licensed under **Creative Commons - Attribution 4.0 (CC-BY 4.0)**. + ------------------------------------