[NEW] Pytest Plugin & Other Project Types

Cookiecutter Python Package v1.6.0 Release

Author: boromir674

.github/biskotaki.yaml

@@ -1,5 +1,6 @@
 default_context:
     project_name: Biskotaki
+    project_type: module
     project_slug: biskotaki
     repo_name: biskotaki
     pkg_name: biskotaki
@@ -10,5 +11,4 @@ default_context:
     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: yes
-    add_cli: no
     interpreters: {"supported-interpreters": ["3.6", "3.7", "3.8", "3.9", "3.10"]}

.github/workflows/test.yaml

@@ -48,11 +48,10 @@ jobs:
       run: |
         PARSER="src/cookiecutter_python/{{ cookiecutter.project_slug }}/scripts/parse_version.py"
         PARSED_VERSION=$(python "${PARSER}")
-        echo $PARSED_VERSION
         echo "PKG_VERSION=$PARSED_VERSION" >> $GITHUB_ENV
 
     - name: Run Test Suite
-      run: tox --sitepackages -vv -s false -- -n auto --run-network_bound
+      run: tox -vv -s false -- -n auto --run-network_bound
       env:
         PLATFORM: ${{ matrix.platform }}
 

.prospector.yml

@@ -10,9 +10,11 @@ ignore-paths:
   - docs
 ignore-patterns:
   - (^|/)skip(this)?(/|$)
-  - src/cookiecutter_python/{{ cookiecutter.project_slug }}/tests/smoke_test.py
+  - src/cookiecutter_python/{{ cookiecutter.project_slug }}/src/{{ cookiecutter.pkg_name }}/__init__.py
   - src/cookiecutter_python/{{ cookiecutter.project_slug }}/src/{{ cookiecutter.pkg_name }}/__main__.py
   - src/cookiecutter_python/{{ cookiecutter.project_slug }}/src/{{ cookiecutter.pkg_name }}/cli.py
+  - src/cookiecutter_python/{{ cookiecutter.project_slug }}/tests/smoke_test.py
+  - src/cookiecutter_python/{{ cookiecutter.project_slug }}/tests/test_cli.py
 autodetect: false
 max-line-length: 95
 

CHANGELOG.rst

@@ -2,6 +2,34 @@
 Changelog
 =========
 
+1.6.0 (2022-06-28)
+==================
+
+Introducing the *Project Type* Generate Variable. Now you can select what
+type of Python Package you intend to develop and the Generation process
+shall adjust to produce the desired skeleton and infrastructure accordingly!
+
+Packaged the existing functionality into the `Module` and `Module + CLI`
+Project Types.
+Added the new `Pytest Plugin` Project Type, designed for developing Pytest
+Plugins and Fixtures (see below).
+
+Project Types currently supported:
+- Module: a Python Package intended to serve exclusively as a Software Library
+- Module + CLI: a Python Package proving a Software Library and an
+    "installable" (executable) Command Line Program/Interface (CLI)
+- Pytest Plugin: a Python Package intended to providing a Pyetst Plugin (ie with
+    a Test Fixture)
+
+Changes
+^^^^^^^
+
+feature
+"""""""
+- add 'project_type' Variable allowing for 'module', 'module+cli' or 'pytest-plugin' Projects
+- conditionaly populate 'test' dependencies, ie based on whether there is a cli entrypoint
+
+
 1.5.2 (2022-06-22)
 ==================
 

README.rst

@@ -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.5.2/master?color=blue&logo=github
+.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v1.6.0/master?color=blue&logo=github
     :alt: GitHub commits since tagged version (branch)
-    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v1.5.2..master
+    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v1.6.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)

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.5.2"
+version = "1.6.0"
 description = "Yet another modern Python Package (pypi) with emphasis in CI/CD and automation."
 authors = ["Konstantinos Lampridis <k.lampridis@hotmail.com>"]
 maintainers = ["Konstantinos Lampridis <k.lampridis@hotmail.com>"]
@@ -98,6 +98,7 @@ requests-futures = "^1.0.0"
 PyInquirer = "^1.0.3"
 prompt-toolkit = "==1.0.14"
 gitpython = "^3.1"
+chardet = "^4.0.0"
 
 # A list of all of the optional dependencies, some of which are included in the
 # below `extras`. They can be opted into by apps.

src/cookiecutter_python/__init__.py

@@ -1 +1 @@
-__version__ = '1.5.2'
+__version__ = '1.6.0'

src/cookiecutter_python/__main__.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """Allow to run Python Generator also through `python -m cookiecutter_python`.
 
 Allows Python Generator to be executed through `python -m cookiecutter_python`.

src/cookiecutter_python/cli.py

@@ -89,7 +89,8 @@ def main(
     like to get in touch, please see
     https://github.com/boromir674/cookiecutter-python-package.
     """
-
+    print(type(exceptions['critical']))
+    # print([_ for _ in exceptions['critical']])
     # TODO Improvement: add logging configuration
     try:
         project: str = generate(

src/cookiecutter_python/cookiecutter.json

@@ -1,5 +1,6 @@
 {
     "project_name": "My New Project",
+    "project_type": ["module", "module+cli", "pytest-plugin"],
     "project_slug": "{{ cookiecutter.project_name|lower|replace(' ', '-') }}",
     "repo_name": "{{ cookiecutter.project_slug }}",
     "pkg_name": "{{ cookiecutter.project_slug|replace('-', '_') }}",
@@ -13,7 +14,6 @@
     "year": "{% now 'utc', '%Y' %}",
     "version": "0.0.1",
     "initialize_git_repo": ["yes", "no"],
-    "add_cli": ["no", "yes"],
     "interpreters": {
         "supported-interpreters": [
             "3.6",