[NEW] Automate Ubuntu and Macos CI builds for the Template Project

Author: boromir674

.github/workflows/test.yaml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ${{ matrix.platform }}
     strategy:
       matrix:
-        platform: [ubuntu-latest]
+        platform: [ubuntu-latest, macos-latest]
         python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
 
     steps:

README.rst

@@ -5,7 +5,7 @@ Python Package (pypi) Cookiecutter, with emphasis on CI/CD and automation.
 
 .. start-badges
 
-| |build| |release_version| |wheel| |supported_versions| |commits_since_specific_tag_on_master| |commits_since_latest_release|
+| |build| |release_version| |wheel| |supported_versions| |commits_since_specific_tag_on_master| |commits_since_latest_github_release|
 
 
 |
@@ -34,39 +34,22 @@ Python Package (pypi) Cookiecutter, with emphasis on CI/CD and automation.
     :alt: Supported Python versions
     :target: https://pypi.org/project/cookiecutter_python
 
-.. |supported_versions_old| image:: https://img.shields.io/pypi/pyversions/cookiecutter_python.svg
-    :alt: Supported Python versions
-    :target: https://pypi.org/project/cookiecutter_python
-
-.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v0.5.4/master?color=blue&logo=github
+.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v0.6.1/master?color=blue&logo=github
     :alt: GitHub commits since tagged version (branch)
-    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v0.5.4..master
+    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v0.6.1..master
 
-.. |commits_since_latest_release| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/latest?color=blue&logo=semver&sort=semver
+.. |commits_since_latest_github_release| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/latest?color=blue&logo=semver&sort=semver
     :alt: GitHub commits since latest release (by SemVer)
-    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v0.5.4..master
-
-
-.. |commits_since| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v0.5.4/master?logo=github
-    :alt: GitHub commits on branch, since tagged version
-    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v0.5.4..master
-
-
 
-.. |circleci| image:: https://circleci.com/gh/boromir674/cookiecutter-python-package/tree/master.svg?style=shield
-    :alt: CircleCI
-    :target: https://circleci.com/gh/boromir674/cookiecutter-python-package/tree/master
 
 .. |codecov| image:: https://img.shields.io/codecov/c/github/boromir674/cookiecutter-python-package/master?logo=codecov
     :alt: Codecov
     :target: https://codecov.io/gh/boromir674/cookiecutter-python-package
 
-
 .. |better_code_hub| image:: https://bettercodehub.com/edge/badge/boromir674/cookiecutter-python-package?branch=master
     :alt: Better Code Hub
     :target: https://bettercodehub.com/
 
-
 .. |sc1| image:: https://img.shields.io/scrutinizer/quality/g/boromir674/cookiecutter-python-package/master?logo=scrutinizer&style=flat
     :alt: Scrutinizer code quality
     :target: https://scrutinizer-ci.com/g/boromir674/cookiecutter-python-package/?branch=master
@@ -92,11 +75,16 @@ Check the `Cookiecutter documentation`_ pages for more on Cookiecutter.
 
 Usage
 =====
+
+Simply, get (clone) the code and generate a Project based on the (downloaded) template.
+
 Open a console/terminal and run:
 
 .. code-block:: sh
 
-    cookiecutter gh:boromir674/cookiecutter-python-package
+    git clone git@github.com:boromir674/cookiecutter-python-package.git
+
+    cookiecutter cookiecutter-python-package/src/cookiecutter_python
 
 
 This will generate a new `Python Package Project` (in the currect dir), using the template from github.

setup.cfg

@@ -1,21 +1,21 @@
 [metadata]
 ## Setuptools specific information
 name = cookiecutter_python
-version = 0.5.4
+version = 0.6.1
 # renders on pypi as subtitle
 description = Yet another modern Python Package (pypi) with emphasis in CI/CD and automation 
 long_description = file: README.rst
 long_description_content_type = text/x-rst
 license = AGPLv3
 license_files = LICENSE
-platforms = All
+platforms = Linux, Darwin
 author = Konstantinos Lampridis
 author_email = k.lampridis@hotmail.com
 
 # represents the web home page of the project
 url = https://github.com/boromir674/cookiecutter-python-package
 
-download_url = https://github.com/boromir674/cookiecutter-python-package/archive/v0.5.0.tar.gz
+download_url = https://github.com/boromir674/cookiecutter-python-package/archive/v0.6.1.tar.gz
 
 ## PyPi specific information
 project_urls =
@@ -48,6 +48,7 @@ classifiers =
 
 
 [options]
+python_requires = >= 3.6
 zip_safe = False
 include_package_data = True
 package_dir=

src/cookiecutter_python/__init__.py

@@ -1 +1 @@
-__version__ = '0.5.4'
+__version__ = '0.6.1'

src/cookiecutter_python/{{ cookiecutter.project_slug }}/.github/workflows/test.yaml

@@ -16,8 +16,8 @@ jobs:
     runs-on: ${{ "{{" }} matrix.platform {{ "}}" }}
     strategy:
       matrix:
-        platform: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [3.6, 3.7, 3.8]
+        platform: [ubuntu-latest, macos-latest]
+        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
 
     steps:
     - uses: actions/checkout@v1
@@ -29,8 +29,8 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         python -m pip install tox tox-gh-actions
-    - name: Do Type Checking
-      run: tox -e type --skip-missing-interpreters false -vv
+    - name: Specify current package version to assist build tool
+      run: echo "PKG_VERSION=$(python scripts/parse_version.py)" >> $GITHUB_ENV
     - name: Run Test Suite
       run: tox --skip-missing-interpreters false -vv
       env:

src/cookiecutter_python/{{ cookiecutter.project_slug }}/README.rst

@@ -4,65 +4,49 @@
 
 .. start-badges
 
-| |circleci| |codecov|
-| |release_version| |wheel| |supported_versions| |commits_since|
-| |better_code_hub| |sc1|
+| |build| |release_version| |wheel| |supported_versions| |commits_since_specific_tag_on_master| |commits_since_latest_github_release|
+
 
 |
 | **Source Code:** https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}
+| **Pypi Package:** https://pypi.org/project/{{ cookiecutter.pkg_name }}/
 |
 
 
+.. Test Workflow Status on Github Actions for specific branch <branch>
+
+.. |build| image:: https://img.shields.io/github/workflow/status/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}/Test%20Python%20Package/master?label=build&logo=github-actions&logoColor=%233392FF
+    :alt: GitHub Workflow Status (branch)
+    :target: https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}/actions/workflows/test.yaml?query=branch%3Amaster
+
+.. above url to workflow runs, filtered by the specified branch
+
 .. |release_version| image:: https://img.shields.io/pypi/v/{{ cookiecutter.pkg_name }}
     :alt: Production Version
     :target: https://pypi.org/project/{{ cookiecutter.pkg_name }}/
 
-.. |wheel| image:: https://img.shields.io/pypi/wheel/{{ cookiecutter.pkg_name }}.svg
-    :alt: Python Wheel
+.. |wheel| image:: https://img.shields.io/pypi/wheel/{{ cookiecutter.pkg_name|replace('_', '-') }}?color=green&label=wheel
+    :alt: PyPI - Wheel
     :target: https://pypi.org/project/{{ cookiecutter.pkg_name }}
 
-.. |supported_versions| image:: https://img.shields.io/pypi/pyversions/{{ cookiecutter.pkg_name }}.svg
+.. |supported_versions| image:: https://img.shields.io/pypi/pyversions/{{ cookiecutter.pkg_name|replace('_', '-') }}?color=blue&label=python&logo=python&logoColor=%23ccccff
     :alt: Supported Python versions
     :target: https://pypi.org/project/{{ cookiecutter.pkg_name }}
 
-.. |commits_since| image:: https://img.shields.io/github/commits-since/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}/v{{ cookiecutter.version }}/master?logo=github
-    :alt: GitHub commits on branch, since tagged version
+.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}/v{{ cookiecutter.version }}/master?color=blue&logo=github
+    :alt: GitHub commits since tagged version (branch)
     :target: https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}/compare/v{{ cookiecutter.version }}..master
 
+.. |commits_since_latest_github_release| image:: https://img.shields.io/github/commits-since/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}/latest?color=blue&logo=semver&sort=semver
+    :alt: GitHub commits since latest release (by SemVer)
 
 
-.. |circleci| image:: https://circleci.com/gh/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}/tree/master.svg?style=shield
-    :alt: CircleCI
-    :target: https://circleci.com/gh/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}/tree/master
-
-.. |codecov| image:: https://img.shields.io/codecov/c/github/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}/master?logo=codecov
-    :alt: Codecov
-    :target: https://codecov.io/gh/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}
-
-
-.. |better_code_hub| image:: https://bettercodehub.com/edge/badge/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}?branch=master
-    :alt: Better Code Hub
-    :target: https://bettercodehub.com/
-
-
-.. |sc1| image:: https://img.shields.io/scrutinizer/quality/g/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}/master?logo=scrutinizer&style=flat
-    :alt: Scrutinizer code quality
-    :target: https://scrutinizer-ci.com/g/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}/?branch=master
-
-
-
-Featuring
+Features
+========
 
 - TODO-feature 1
 - TODO-feature 2
 
-
-========
-Overview
-========
-
-* Free software: Affero GNU General Public License v3.0
-
 Prerequisites
 =============
 
@@ -73,9 +57,17 @@ Installation
 
 Using `pip` is the approved way for installing `{{ cookiecutter.pkg_name }}`.
 
+.. code-block:: sh
+
+    python3 -m pip install {{ cookiecutter.pkg_name }}
+
 
 Usage
 =====
 
-How it works
-============
+TODO
+
+License
+=======
+
+* Free software: Affero GNU General Public License v3.0

src/cookiecutter_python/{{ cookiecutter.project_slug }}/scripts/parse_version.py

@@ -0,0 +1,59 @@
+#!/usr/bin/env python
+
+
+import os
+import re
+import sys
+
+my_dir = os.path.dirname(os.path.realpath(__file__))
+
+SETUP_CFG_FILENAME = 'setup.cfg'
+SETUP_CFG = os.path.join(my_dir, '../', SETUP_CFG_FILENAME)
+
+
+def main():
+    """Get the package version string provided that the developer has setup indication how to find it. Reads the
+    [semantic_release] section found in setup.cfg and then determines where is the actual version string
+    """
+    # Automatically compute package version from the [semantic_release] section in setup.cfg
+    with open(SETUP_CFG, 'r') as _file:
+        regex = r"\[semantic_release\][\w\s=/\.:\d]+version_variable[\ \t]*=[\ \t]*([\w\.]+(?:/[\w\.]+)*):(\w+)"
+        match = re.search(regex, _file.read(), re.MULTILINE)
+        if match:
+            file_with_version_string = os.path.join(my_dir, '../', match.group(1))
+            variable_holding_version_value = match.group(2)
+        else:
+            raise RuntimeError(
+                f"Expected to find the '[semantic_release]' section, in the '{SETUP_CFG}' file, with key "
+                f"'version_variable'.\nFor example:\n[semantic_release]\nversion_variable = "
+                f"src/package_name/__init__.py:__version__\n indicated that the version string should be looked up in "
+                f"the src/package_name/__init__.py file registered under the __version__ 'name'")
+
+    # (it does not have to be a.py file)
+    # to indicate that the version is stored in the '__version__'
+    if not os.path.isfile(file_with_version_string):
+        raise FileNotFoundError(
+            f"Path '{file_with_version_string} does not appear to be valid. Please go to the '{SETUP_CFG}' file, at the"
+            f" [semantic_release] section and set the 'version_variable' key with a valid file path (to look for the "
+            f"version string)")
+
+    reg_string = r'\s*=\s*[\'\"]([^\'\"]*)[\'\"]'
+
+
+    with open(file_with_version_string, 'r') as _file:
+        content = _file.read()
+        reg = f'^{variable_holding_version_value}' + reg_string
+        match = re.search(reg, content, re.MULTILINE)
+        if match:
+            _version = match.group(1)
+            return _version
+        raise AttributeError(f"Could not find a match for regex {reg} when applied to:\n{content}")
+
+
+if __name__ == '__main__':
+    try:
+        version_string = main()
+        print(version_string)
+    except (RuntimeError, FileNotFoundError, AttributeError) as exception:
+        print(exception)
+        sys.exit(1)