[NEW] Py Pkg Gen with Offline option

Release Version '1.12.5' into 'master' Branch

Author: boromir674

CHANGELOG.rst

@@ -2,6 +2,29 @@
 Changelog
 =========
 
+1.12.5 (2024-02-11)
+===================
+
+We add `--offline` as optional CLI flag to the `generate-python` CLI.
+We keep the default behaviour of the CLI to be `online`, ie to make Async Http requests.
+
+
+Changes
+^^^^^^^
+
+feature
+"""""""
+- add CLI option to deactivate Async Http requests for PyPI and RTD web servers
+
+dev
+"""
+- run with --offline flag the Snapshot Update Scripts
+
+release
+"""""""
+- bump version to 1.12.5
+
+
 1.12.5-dev1 (2024-02-10)
 ========================
 

README.rst

@@ -275,9 +275,9 @@ Free/Libre and Open Source Software (FLOSS)
 
 .. Github Releases & Tags
 
-.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v1.12.5-dev1/master?color=blue&logo=github
+.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v1.12.5/master?color=blue&logo=github
     :alt: GitHub commits since tagged version (branch)
-    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v1.12.5-dev1..master
+    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v1.12.5..master
 
 .. |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)

docs/conf.py

@@ -30,7 +30,7 @@
 author = 'Konstantinos Lampridis'
 
 # The full version, including alpha/beta/rc tags
-release = '1.12.5-dev1'
+release = '1.12.5'
 
 # -- General configuration ---------------------------------------------------
 

pyproject.toml

@@ -10,7 +10,7 @@ build-backend = "poetry.core.masonry.api"
 ## Also renders on pypi as 'subtitle'
 [tool.poetry]
 name = "cookiecutter_python"
-version = "1.12.5-dev1"
+version = "1.12.5"
 description = "1-click Generator of Python Project, from Template with streamlined \"DevOps\" using a powerful CI/CD Pipeline."
 authors = ["Konstantinos Lampridis <k.lampridis@hotmail.com>"]
 maintainers = ["Konstantinos Lampridis <k.lampridis@hotmail.com>"]

scripts/update-snapshot-interactive.sh

@@ -15,7 +15,7 @@ set -e
 
 ### RUN Generator in Interactive Mode, prompting/asking for user input ###
 echo
-.tox/dev/bin/generate-python --config-file .github/biskotaki.yaml -o /tmp/
+.tox/dev/bin/generate-python --offline --config-file .github/biskotaki.yaml -o /tmp/
 
 ### UPDATE SHAPSHOT, by Copying all Generated files and folders recursively ###
 INTERACTIVE_SHAPSHOT=${INTERACTIVE_SHAPSHOT:-tests/data/snapshots/biskotaki-interactive}

scripts/update-snapshot.sh

@@ -14,7 +14,7 @@ set -e
 
 ### RUN Generator in Non-Interactive Mode ###
 echo
-.tox/dev/bin/generate-python --no-input --config-file .github/biskotaki.yaml -o /tmp/
+.tox/dev/bin/generate-python --offline --no-input --config-file .github/biskotaki.yaml -o /tmp/
 
 
 ### UPDATE SHAPSHOT, by Copying all Generated files and folders recursively ###

src/cookiecutter_python/__init__.py

@@ -1,3 +1,3 @@
-__version__ = '1.12.5-dev1'
+__version__ = '1.12.5'
 
 from . import _logging  # noqa

src/cookiecutter_python/backend/main.py

@@ -17,6 +17,7 @@
 def generate(
     # interactive=True,
     no_input=False,  # INTERACTIVE ON by Default
+    offline=False,
     extra_context=None,
     replay=False,
     overwrite=False,
@@ -49,10 +50,11 @@ def generate(
             web_servers=WEB_SERVERS,
             no_input=no_input,
             extra_context=extra_context,
+            offline=offline,
         )
     )
     print('Extra context: ', request.extra_context)
-    ## GENERATION ##
+    ## GENERATION from Template; delegate to Cookiecutter callable ##
     project_dir = generator(
         os.path.abspath(os.path.join(my_dir, '..')),  # template dir path
         checkout=checkout,

src/cookiecutter_python/backend/pre_main.py

@@ -15,9 +15,18 @@ def pre_main(request):
     # making http request to web servers hosting endpoints for APIs
 
     # Checkers are initialized as 'Activated'
-    #  if User Config is True and Default Config is False
 
-    request.check = Engine.create(request.config_file, request.default_config)
+    # Activate Async HTTP only if all below are True:
+    # - User did not pass the --offline CLI flag
+    # - User did not pass the --default-config CLI flag
+    # - User passed a Config file YAML
+
+    # Activate: if User Config is given and Default Config is False
+    deactivate_signal: bool = bool(request.default_config)
+    if request.offline:
+        deactivate_signal = True
+
+    request.check = Engine.create(request.config_file, deactivate_signal)
 
     # Start Requesting Futures! - Hosting Service: PyPI, Read The Docs
     request.check_results = request.check.check(request.web_servers)

src/cookiecutter_python/backend/request.py

@@ -14,3 +14,4 @@ class Request:
     extra_context: dict
     check: Any = attr.ib(default=None)
     check_results: Union[None, Iterable[CheckWebServerResult]] = attr.ib(default=None)
+    offline: bool = False