[NEW] Python Generator CLI and Async features

Author: boromir674

.github/biskotaki.yaml

@@ -9,4 +9,4 @@ default_context:
     author_email: k.lampridis@hotmail.com
     github_username: boromir674
     project_short_description: Project generated from the https://github.com/boromir674/cookiecutter-python-package/tree/master/src/cookiecutter_python cookiecutter
-    initialize_git_repo: "no"
+    initialize_git_repo: yes

.github/workflows/generate.yaml

@@ -87,22 +87,23 @@ jobs:
 
       - name: Generate Biskotaki from Template
         run: |
+          pip install --user -e .
           echo "    version: \"${{ env.BISKOTAKI_VERSION }}\"" >> .github/biskotaki.yaml
-          cookiecutter ./src/cookiecutter_python -o gen --config-file ./.github/biskotaki.yaml --no-input
+          generate-python -o gen --config-file ./.github/biskotaki.yaml --no-input
 
-      # - name: Test against multiple 'installation' scenarios
-      #   run: |
-      #     cd gen/biskotaki
-      #     tox -e "py38{, -path, -sdist, -wheel, -dev}"
-      #   env:
-      #     PKG_VERSION: ${{ env.BISKOTAKI_VERSION }}
-    #   - name: Test Operations such as 'build process' and 'linting'
-    #     run: |
-    #       cd gen/biskotaki
-    #       tox -e check
-    #       tox -e build
-    #       tox -e lint
-    #       tox -e graphs
+      - name: Test against multiple 'installation' scenarios
+        run: |
+          cd gen/biskotaki
+          tox -e "py38{, -path, -sdist, -wheel, -dev}"
+        env:
+          PKG_VERSION: ${{ env.BISKOTAKI_VERSION }}
+      - name: Test Operations such as 'build process' and 'linting'
+        run: |
+          cd gen/biskotaki
+          tox -e check
+          tox -e build
+          tox -e lint
+          tox -e graphs
 
       - name: Push to dedicated branch in biskotaki repo
         uses: cpina/github-action-push-to-another-repository@main

.github/workflows/test.yaml

@@ -21,8 +21,6 @@ jobs:
     strategy:
       matrix:
         platform: [ubuntu-latest, macos-latest]
-        # platform: [ubuntu-latest]
-        # python-version: ["3.6", "3.10"]
         python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
 
     steps:
@@ -45,32 +43,32 @@ jobs:
     - name: Check for compliance with Python Best Practices
       run: tox -e check -vv -s false
 
-    # - name: Specify current package version to assist build tool
-    #   run: echo "PKG_VERSION=$(python scripts/parse_version.py)" >> $GITHUB_ENV
+    - 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 -vv -s false
-    #   env:
-    #     PLATFORM: ${{ matrix.platform }}
+    - name: Run Test Suite
+      run: tox -vv -s false
+      env:
+        PLATFORM: ${{ matrix.platform }}
 
-    # - name: Install coverage.py
-    #   run: python -m pip install coverage
+    - name: Install coverage.py
+      run: python -m pip install coverage
 
-    # - name: Aggregate Test Suite Coverage Data
-    #   run: |
-    #     python -m pip install coverage
-    #     tox -e coverage --sitepackages -vv -s false
+    - name: Aggregate Test Suite Coverage Data
+      run: |
+        python -m pip install coverage
+        tox -e coverage --sitepackages -vv -s false
 
-    # # TODO Delegate uploading to codecov to a another Job
-    # - name: Upload coverage to Codecov
-    #   uses: codecov/codecov-action@v2
-    #   with:
-    #     directory: ./.tox/
-    #     env_vars: OS,PYTHON
-    #     fail_ci_if_error: true
-    #     files: ./.tox/coverage.xml
-    #     flags: unittests
-    #     name: codecov-umbrella
-    #     verbose: true
+    # TODO Delegate uploading to codecov to a another Job
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v2
+      with:
+        directory: ./.tox/
+        env_vars: OS,PYTHON
+        fail_ci_if_error: true
+        files: ./.tox/coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+        verbose: true
 
     # TODO find build tar.gz whl files and upload as artefacts

.gitignore

@@ -20,4 +20,7 @@ node_modules
 dependency-graphs/
 test-results/
 uml-diagrams/
-pydoer-graphs/
+pydoer-graphs/
+
+package-lock\.json
+package\.json

.pylintrc

@@ -227,7 +227,7 @@ contextmanager-decorators=contextlib.contextmanager
 # List of members which are set dynamically and missed by pylint inference
 # system, and so shouldn't trigger E1101 when accessed. Python regular
 # expressions are accepted.
-generated-members=_transform|self\.objects|self\._observers
+generated-members=_transform|self\.objects|self\._observers|subclasses
 
 # Tells whether missing members accessed in mixin class should be ignored. A
 # mixin class is detected if its name ends with "mixin" (case insensitive).
@@ -279,7 +279,12 @@ missing-member-hint-distance=1
 missing-member-max-choices=1
 
 # List of decorators that change the signature of a decorated function.
-signature-mutators=
+signature-mutators=click.decorators.option,
+                   click.decorators.argument,
+                   click.decorators.version_option,
+                   click.decorators.help_option,
+                   click.decorators.pass_context,
+                   click.decorators.confirmation_option
 
 
 [BASIC]

CHANGELOG.rst

@@ -2,6 +2,30 @@
 Changelog
 =========
 
+1.1.0 (2022-05-17)
+==================
+
+Wrapping everything in a *command line interface* (cli).
+Speed up performance by using *futures* for http requests.
+
+Changes
+^^^^^^^
+
+feature
+"""""""
+- allow user to control parameters of the project generation process
+- expose project generator through an interactive cli
+- add async capabilities to the pre_gen_project.py for faster network bound operations
+
+documentation
+"""""""""""""
+- demonstrate how to install and use the cli
+
+ci
+""
+- update workflow to install and use the 'generate-python' cli
+
+
 1.0.0 (2022-05-11)
 ==================
 

README.rst

@@ -61,11 +61,12 @@ Generated Python Package Features
 Quickstart
 ==========
 
-Prerequisites
--------------
+Installation
+------------
 
-You need to have Cookiecutter installed.
-Check the `Cookiecutter documentation`_ pages for more on Cookiecutter.
+    .. code-block: shell
+
+        pip install --user cookiecutter-python
 
 
 Usage
@@ -75,8 +76,7 @@ Open a console/terminal and run:
 
   .. code-block:: sh
 
-      git clone git@github.com:boromir674/cookiecutter-python-package.git
-      cookiecutter cookiecutter-python-package/src/cookiecutter_python
+      generate-python
 
 Now, you should have generated a new Project for a Python Package, based on the `Template`_!
 
@@ -89,7 +89,7 @@ Now, you should have generated a new Project for a Python Package, based on the
 Try Running the Test Suite!
 
     .. code-block:: shell
-        
+
         tox
 
 
@@ -147,7 +147,7 @@ For more complex use cases, you can modify the Template and also leverage all of
 
 .. _Template: https://github.com/boromir674/cookiecutter-python-package/tree/master/src/cookiecutter_python
 
-.. _Use Cases: https://python-package-generator.readthedocs.io/en/master/usage/use_cases.html
+.. _Use Cases: https://python-package-generator.readthedocs.io/en/master/contents/30_usage/index.html#new-python-package-use-cases
 
 .. _GNU Affero General Public License v3.0: https://github.com/boromir674/cookiecutter-python-package/blob/master/LICENSE
 
@@ -196,9 +196,9 @@ For more complex use cases, you can modify the Template and also leverage all of
 
 .. Github Releases & Tags
 
-.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v1.0.0/master?color=blue&logo=github
+.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v1.1.0/master?color=blue&logo=github
     :alt: GitHub commits since tagged version (branch)
-    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v1.0.0..master
+    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v1.1.0..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)
@@ -235,16 +235,16 @@ For more complex use cases, you can modify the Template and also leverage all of
 
 .. |codacy| image:: https://app.codacy.com/project/badge/Grade/5be4a55ff1d34b98b491dc05e030f2d7
     :alt: Codacy
-    :target: https://www.codacy.com/gh/boromir674/cookiecutter-python-package/dashboard?utm_source=github.com&utm_medium=referral&utm_content=boromir674/cookiecutter-python-package&utm_campaign=Badge_Grade
+    :target: https://app.codacy.com/gh/boromir674/cookiecutter-python-package/dashboard?utm_source=github.com&utm_medium=referral&utm_content=boromir674/cookiecutter-python-package&utm_campaign=Badge_Grade
 
 
 .. Code Climate CI
 .. Code maintainability & Technical Debt
 
 .. |maintainability| image:: https://api.codeclimate.com/v1/badges/1d347d7dfaa134fd944e/maintainability
    :alt: Maintainability
-   :target: https://codeclimate.com/github/boromir674/cookiecutter-python-package/maintainability
+   :target: https://codeclimate.com/github/boromir674/cookiecutter-python-package/
 
 .. |tech-debt| image:: https://img.shields.io/codeclimate/tech-debt/boromir674/cookiecutter-python-package
     :alt: Code Climate technical debt
-    :target: https://codeclimate.com/github/boromir674/cookiecutter-python-package/maintainability
+    :target: https://codeclimate.com/github/boromir674/cookiecutter-python-package/

docs/contents/30_usage/generate_project.rst

@@ -1,18 +1,10 @@
 
 | The most common way to generate a new Python Package Project (in the current working directory),
-| is to invoke the *cookiecutter* cli (while supplying the necessary initial information when prompted)
-| and provide this Template as input.
+| is to invoke the *generate-python* cli (while supplying the necessary initial
+| information if/when prompted).
 
 Open a console (ie terminal) and run: 
 
 .. code-block:: shell
   
-  # Get Template
-  git clone git@github.com/boromir674/cookiecutter-python-package.git
-
-  # Install cookiecutter if you haven't
-  python -m pip3 install cookiecutter 
-
-  # Generate a new Python Package Project locally
-  cookiecutter cookiecutter-python-package/src/cookiecutter_python
-
+  generate-python

docs/contents/30_usage/index.rst

@@ -2,15 +2,16 @@
 Generate New Python Package Project
 ===================================
 
-.. include:: generate_project.rst
-
+This *pyton generator* was designed to be installed via *pip* and then invoked through
+the cli.
 
 ------------
 Installation
 ------------
 
 .. include:: installation.rst
 
+.. include:: generate_project.rst
 
 
 .. _Use Cases:

docs/contents/30_usage/installation.rst

@@ -1,19 +1,51 @@
 
-| **Cookiecutter Python Package** is available directly as source code on github, but also being a Python Package Generator/Template,
-| available on pypi too.
+| **Cookiecutter Python Package**, available as source code on github, is also published
+| on *pypi.org*.
 
 
-Get Code from Github
---------------------
+Install as PyPi package
+-----------------------
 
-.. code-block:: shell
 
-  git clone git@github.com:boromir674/cookiecutter-python-package.git
+In virtual environment (recommended)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+The recommended way of installing any python package, is use a *python virtual environment*.
 
-Install PyPI package (in current environment)
----------------------------------------------
+Open a console (aka terminal) and run:
 
 .. code-block:: shell
 
-  python3 -m pip install cookiecutter-python
+  virtualenv env --python=python3
+  source env/bin/activate
+
+  pip install cookiecutter-python
+
+  deactivate
+
+  ln -s env/bin/generate-python ~/.local/bin/generate-python
+
+Now the *generate-python* executable should be available (assuming ~/.local/bin is in your PATH)!
+
+
+For user 
+^^^^^^^^
+
+One could also opt for a *user* installation of *cookiecutter-python* package:
+
+.. code-bloack: shell
+
+  python3 -m pip install --user cookiecutter-python
+
+
+For all users
+^^^^^^^^^^^^^
+
+The least recommended way of installing *cookiecutter-python* package is to
+*directly* install in the *host* machine:
+
+.. code-bloack: shell
+
+  sudo python3 -m pip install cookiecutter-python
+
+Note the need to invoke using *sudo*, hence not that much recommended.