✨ feat: add support for a Typer CLI and strict typing

Author: bassemkaroui

copier.yaml

@@ -27,156 +27,176 @@ project_description:
     help: Your project description
 
 project_keywords:
-  default: "python,{{ project_name | lower }}"
-  type: str
-  help: "Provide a list of comma-separated keywords to be using in the Python package overview:"
+    default: "python,{{ project_name | lower }}"
+    type: str
+    help: "Provide a list of comma-separated keywords to be using in the Python package overview:"
 
 author_fullname:
-  type: str
-  help: Your full name
-  default: "{{ 'Bassem Karoui' | git_user_name }}"
+    type: str
+    help: Your full name
+    default: "{{ 'Bassem Karoui' | git_user_name }}"
 
 author_email:
-  type: str
-  help: Your email
-  default: "{{ 'bassem.karoui1@gmail.com' | git_user_email }}"
+    type: str
+    help: Your email
+    default: "{{ 'bassem.karoui1@gmail.com' | git_user_email }}"
 
 repository_provider:
-  type: str
-  help: Your repository provider
-  default: github
-  choices:
-  - github
-  - other
+    type: str
+    help: Your repository provider
+    default: github
+    choices:
+    - github
+    - other
 
 author_github_handle:
-  when: "{{ repository_provider == 'github' }}"
-  type: str
-  help: Your Github handle
-  default: "{{ author_fullname | lower | replace(' ', '')}}"
+    when: "{{ repository_provider == 'github' }}"
+    type: str
+    help: Your Github handle
+    default: "{{ author_fullname | lower | replace(' ', '')}}"
 
 homepage:
-  when: "{{ repository_provider == 'github' }}"
-  type: str
-  help: "The project Homepage"
-  default: "https://{{ author_github_handle }}.github.io/{{ project_name }}"
+    when: "{{ repository_provider == 'github' }}"
+    type: str
+    help: "The project Homepage"
+    default: "https://{{ author_github_handle }}.github.io/{{ project_name }}"
 
 repository:
-  when: "{{ repository_provider == 'github' }}"
-  type: str
-  help: "The project Repository"
-  default: "https://github.com/{{ author_github_handle }}/{{ project_name }}"
+    when: "{{ repository_provider == 'github' }}"
+    type: str
+    help: "The project Repository"
+    default: "https://github.com/{{ author_github_handle }}/{{ project_name }}"
 
 documentation:
-  when: "{{ repository_provider == 'github' }}"
-  type: str
-  help: "The project Documentation"
-  default: "https://{{ author_github_handle }}.github.io/{{ project_name }}"
+    when: "{{ repository_provider == 'github' }}"
+    type: str
+    help: "The project Documentation"
+    default: "https://{{ author_github_handle }}.github.io/{{ project_name }}"
 
 copyright_license:
-  type: str
-  help: Choose the project's license (e.g. "MIT", "GPL-3.0").
-  default: MIT License
-  choices:
-    - Apache Software License
-    - BSD 3-clause License
-    - Boost Software License 1.0 (BSL-1.0)
-    - GNU General Public License v3 (GPLv3)
-    - ISC License
-    - MIT License
-    - The Unlicense (Unlicense)
+    type: str
+    help: Choose the project's license (e.g. "MIT", "GPL-3.0").
+    default: MIT License
+    choices:
+      - Apache Software License
+      - BSD 3-clause License
+      - Boost Software License 1.0 (BSL-1.0)
+      - GNU General Public License v3 (GPLv3)
+      - ISC License
+      - MIT License
+      - The Unlicense (Unlicense)
 
 copyright_holder:
-  type: str
-  help: Name or organization holding the copyright
-  default: "{{ author_fullname }}"
+    type: str
+    help: Name or organization holding the copyright
+    default: "{{ author_fullname }}"
 
 copyright_year:
-  when: false
-  type: str
-  default: "{{ current_year }}"
+    when: false
+    type: str
+    default: "{{ current_year }}"
 
 python_version:
-  type: str
-  help: "Choose the default Python version for development, documentation generation, and package build:"
-  default: "3.12"
-  choices:
-    - "3.10"
-    - "3.11"
-    - "3.12"
-    - "3.13"
+    type: str
+    help: "Choose the default Python version for development, documentation generation, and package build:"
+    default: "3.12"
+    choices:
+      - "3.10"
+      - "3.11"
+      - "3.12"
+      - "3.13"
 
 min_python_version:
-  type: str
-  help: "Choose the minimum Python version the project should support:"
-  default: "3.10"
-  choices:
-    - "3.10"
-    - "3.11"
-    - "3.12"
-    - "3.13"
+    type: str
+    help: "Choose the minimum Python version the project should support:"
+    default: "3.10"
+    choices:
+      - "3.10"
+      - "3.11"
+      - "3.12"
+      - "3.13"
 
 py_versions:
-  default: ["3.10", "3.11", "3.12", "3.13"]
-  when: false
+    default: ["3.10", "3.11", "3.12", "3.13"]
+    when: false
+
+with_typer_cli:
+    type: bool
+    help: Does your project need a Typer CLI?
+    default: false
+
+cli_name:
+    type: str
+    help: Set the CLI's name
+    default: "{{ project_name }}"
+    validator: >-
+        {% if not (project_name | regex_search('^[a-z][a-z0-9\-]+$')) %}
+        project_name must start with a letter, followed by one or more letters,
+        digits or dashes all lowercase.
+        {% endif %}
+
+with_strict_typing:
+    type: bool
+    help: Do you want to use strict typing?
+    default: false
 
 tox:
-  type: bool
-  default: true
-  help: Do you want to use Tox?
+    type: bool
+    default: true
+    help: Do you want to use Tox?
 
 coverage_threshold:
-  type: int
-  default: 100
-  help: "Set the threshold for test coverage, ranging from 0 to 100:"
-  validator: "{% if not 0 <= coverage_threshold <= 100 %}Test Coverage threshold should be between 0 and 100{% endif %}"
+    type: int
+    default: 100
+    help: "Set the threshold for test coverage, ranging from 0 to 100:"
+    validator: "{% if not 0 <= coverage_threshold <= 100 %}Test Coverage threshold should be between 0 and 100{% endif %}"
 
 with_conventional_commits:
-  type: bool
-  help: >-
-    Do you want to follow the Conventional Commits standard (https://www.conventionalcommits.org)
-    for your commit messages?
-  default: true
+    type: bool
+    help: >-
+      Do you want to follow the Conventional Commits standard (https://www.conventionalcommits.org)
+      for your commit messages?
+    default: true
 
 cz_gitmoji:
-  type: bool
-  help: Do you want to use emojis for your commits?
-  default: true
-  when: "{{ with_conventional_commits }}"
+    type: bool
+    help: Do you want to use emojis for your commits?
+    default: true
+    when: "{{ with_conventional_commits }}"
 
 gpg_sign_tags:
-  type: bool
-  default: "{{ false | are_tags_gpg_signed }}"
-  when: false
+    type: bool
+    default: "{{ false | are_tags_gpg_signed }}"
+    when: false
 
 publish_to_pypi:
-  type: bool
-  default: false
-  help: Do you want to publish a release to PyPI?
+    type: bool
+    default: false
+    help: Do you want to publish a release to PyPI?
 
 dockerfile:
-  type: bool
-  default: true
-  help: Do you need a Dockerfile?
+    type: bool
+    default: true
+    help: Do you need a Dockerfile?
 
 privileged_container:
-  type: bool
-  when: "{{ dockerfile }}"
-  default: false
-  help: Do you want your container to have root access?
+    type: bool
+    when: "{{ dockerfile }}"
+    default: false
+    help: Do you want your container to have root access?
 
 uid:
-  type: int
-  when: false
-  default: "{{ uid }}"
+    type: int
+    when: false
+    default: "{{ uid }}"
 
 gid:
-  type: int
-  when: false
-  default: "{{ gid }}"
+    type: int
+    when: false
+    default: "{{ gid }}"
 
 gpus:
-  type: bool
-  when: "{{ dockerfile }}"
-  help: Do you need GPU capabilities for you containers?
-  default: false
+    type: bool
+    when: "{{ dockerfile }}"
+    help: Do you need GPU capabilities for you containers?
+    default: false

template/pyproject.toml.jinja

@@ -37,6 +37,12 @@ Repository = "{{ repository }}"
 Documentation = "{{ documentation }}"
 {%- endif %}
 
+
+{% if with_typer_cli -%}
+[project.scripts]
+{{ cli_name }} = "{{ project_slug }}.cli.main:app"
+{%- endif %}
+
 [dependency-groups]
 dev = [
     "pytest>=8.3.5",

template/src/{{project_slug}}/__init__.py

@@ -0,0 +1 @@
+from {{ project_slug }}.__version__ import __version__

template/src/{{project_slug}}/{% if with_strict_typing %}py.typed{% endif %}

@@ -0,0 +1,3 @@
+from {{ project_slug }}.cli.main import app
+
+app(prog_name="{{ package_name }}")

template/src/{{project_slug}}/{% if with_typer_cli %}__main__.py{% endif %}.jinja

@@ -0,0 +1,10 @@
+from rich import print as rprint
+from typer import Typer
+
+from {{ project_slug }} import __version__
+
+app = typer.Typer()
+
+@app.command(rich_help_panel="Help and Others", help="Show the CLI's version.")
+def version() -> None:
+    rprint(f"{{ cli_name }} Version: [green]{__version__}[/green]")

template/src/{{project_slug}}/{% if with_typer_cli %}cli{% endif %}/__init__.py

@@ -0,0 +1,27 @@
+from typing import Annotated
+
+from rich import print as rprint
+from typer import Typer
+
+from {{ project_slug }} import __version__
+from {{ project_slug }}.cli.commands import version
+
+app = typer.Typer(
+    help="{{ package_name }} CLI.",
+    no_args_is_help=True,
+    rich_markup_mode="rich",
+    # epilog="Made with [red]:heart:[/red] by [bold]Bassem Karoui[/bold]",
+    # pretty_exceptions_show_locals=False,
+)
+
+
+@app.callback(invoke_without_command=True)
+def callback(
+    version: Annotated[bool, typer.Option("--version", help="Show the CLI's version.")] = False,
+) -> None:
+    if version:
+        rprint(f"{{ cli_name }} Version: [green]{__version__}[/green]")
+        raise typer.Exit()
+
+
+app.add_typer(version.app, help="Show the CLI's version.")