feat: Updated dependencies, improved README, small improvements for the cookiecutter files (using cookiecutter.project_slug where needed), improved example command with parameters, added a basic test

README.md

@@ -1,13 +1,21 @@
-# Cookiecutter for Python Click CLI :cookie:
+# Important note
+A newer version of this Cookiecutter (using the amazing [Typer](https://typer.tiangolo.com/)!) is currently work in progress and available [here](https://github.com/ltpitt/python-cookiecutter-typer-cli).
+
+# A cookiecutter to bake tasty Python Click CLI tools :cookie:
+
+![Come to the dark side... We have cookies!](https://github.com/ltpitt/cookiecutter-python-cli/blob/master/darth_vader_cookies.jpg?raw=true)
 
 ## Comes with:
 
+ - [x] Containerization
  - [x] Pre-commit hooks
- - [x] mypy
+ - [x] black
+ - [x] click
  - [x] flake8
  - [x] mkdocs-material
+ - [x] mypy
  - [x] packaging
- - [x] Containerization
+
 
 ## Usage
 
@@ -30,24 +38,36 @@ $ cookiecutter gh:yankeexe/cookiecutter-python-cli
 2. Create a virtual environment.
 
 ```bash
-$ make venv
+$ python -m venv venv
 ```
 
-3. Activate it.
+3. Linux / Mac - Activate it.
 
 ```bash
-$ source venv/bin/activate
+$ source venv/Scripts/activate
 ```
 
-4. Install development dependencies with editable mode to test the CLI.
+3. Windows - Activate it.
+
+```bash
+$ source venv/Scripts/Activate.ps1
+```
+
+4. Linux / Mac - Install development dependencies with editable mode to test the CLI.
 
 ```bash
 $ make install
 ```
 
+4. Windows - Install development dependencies with editable mode to test the CLI.
+
+```bash
+$ pip install -e . -r requirements/dev.txt
+```
+
 ## Take your CLI for a spin
 
-This Cookiecutter comes with two generic CLI commands, namely, `init` and `show`.
+This Cookiecutter comes with two generic CLI commands, namely, `init` and `hello`.
 
 > **NOTE**
 >
@@ -58,7 +78,7 @@ $ <<cli_command>> init
 ```
 
 ```bash
-$ <<cli_command>> show
+$ <<cli_command>> hello
 ```
 
 ### Test with Docker
@@ -67,7 +87,7 @@ CLI commands can be tested with Docker.
 
 1. Build an image for the CLI.
 
-    Image is tagged with the same name as the `cli_command`.
+    Image is tagged <<cli_command>> name.
 
 ```bash
 $ make docker-image
@@ -81,19 +101,31 @@ $ docker-run --rm <<cli_command>> init
 
 ## Documentation
 
-1. Install documentation-related dependencies.
+1. Linux / Mac - Install documentation-related dependencies.
 
 ```bash
 $ make docs
 ```
 
-2. Serve the docs locally.
+1. Windows - Install development dependencies with editable mode to test the CLI.
+
+```bash
+$ pip install -r requirements/docs.txt
+```
+
+2. Linux / Mac - Serve the docs locally.
 
 ```bash
 $ make serve-docs
 ```
 
-## Distribution
+2. Windows - Serve the docs locally.
+
+```bash
+$ mkdocs serve -f docs/mkdocs.yml
+```
+
+## Linux / Mac - Distribution
 
 > **NOTE**
 >
@@ -111,7 +143,7 @@ $ make distributions
 $ twine dist/*
 ```
 
-## Help
+## Linux / Mac - Help
 
 For help related to make commands.
 

cookiecutter.json

@@ -1,7 +1,7 @@
 {
     "project_name": "Awesome CLI",
     "project_slug": "{{cookiecutter.project_name.strip().lower().replace(' ', '_').replace('-', '_')}}",
-    "cli_command": "yocli",
+    "cli_command": "acli",
     "author": "Yankee Maharjan",
-    "description": "This CLI tool does awesome things."
+    "description": "This CLI tool does one thing and does it awesomely."
 }

{{cookiecutter.project_slug}}/Makefile

@@ -18,7 +18,7 @@ test: # run pytest in verbose mode
 	@pytest -vvv
 
 venv: # create a virtual env
-	@python3 -m venv venv
+	@python -m venv venv
 
 format: # format all files using black
 	@black .
@@ -41,7 +41,7 @@ serve-docs: # serve docs on localhost
 
 distributions: # create distribution wheel and zip for PyPI
 	@pip install -r requirements/publish.txt
-	@python3 setup.py sdist bdist_wheel
+	@python setup.py sdist bdist_wheel
 	@echo "Use `twine upload dist/*` to upload to PyPI"
 
 docker-image:

{{cookiecutter.project_slug}}/README.md

@@ -24,7 +24,7 @@ $ make install
 
 ## Take your CLI for a spin
 
-This Cookiecutter comes with two generic CLI commands, namely, `init` and `show`.
+This Cookiecutter comes with two generic CLI commands, namely, `init` and `hello`.
 
 ```bash
 $ {{cookiecutter.cli_command.strip().lower().replace(' ', '_').replace('-', '_')}} init

{{cookiecutter.project_slug}}/docs/docs/index.md

@@ -1 +1,7 @@
 # Welcome to {{cookiecutter.project_name}}
+
+::: mkdocs-click
+    :module: {{cookiecutter.project_slug}}.app
+    :command: {{cookiecutter.cli_command}}
+    :depth: 1
+

{{cookiecutter.project_slug}}/docs/mkdocs.yml

@@ -5,13 +5,6 @@ theme:
   features:
     - navigation.instant
 
-nav:
-  - Overview:
-    - Introduction: index.md
-  - Commands:
-    - Overview: ./commands/index.md
-
-# Extensions
 markdown_extensions:
   - markdown.extensions.admonition
   - markdown.extensions.codehilite:
@@ -37,3 +30,12 @@ markdown_extensions:
   - pymdownx.tasklist:
       custom_checkbox: true
   - pymdownx.tilde
+  - mkdocs-click
+
+plugins:
+    - search
+    - markdownextradata: {}
+
+
+extra:
+  cli_command: "{{cookiecutter.cli_command}}"

{{cookiecutter.project_slug}}/requirements/dev.in

@@ -3,8 +3,8 @@
 pip-tools
 pre-commit
 tox
-mypy
 flake8
-pytest
 black
-pre-commit
+click
+typing-extensions
+rich

{{cookiecutter.project_slug}}/requirements/dev.txt

@@ -1,26 +1,44 @@
 #
-# This file is autogenerated by pip-compile
+# This file is autogenerated by pip-compile with python 3.9
 # To update, run:
 #
 #    pip-compile requirements/dev.in
 #
 appdirs==1.4.4
     # via virtualenv
+atomicwrites==1.4.1
+    # via pytest
 attrs==20.3.0
     # via pytest
+black==22.8.0
+    # via -r requirements/dev.in
+build==0.8.0
+    # via pip-tools
 cfgv==3.2.0
     # via pre-commit
-click==7.1.2
+click==8.1.3
     # via
+    #   -r requirements/dev.in
+    #   black
     #   mkdocs
     #   nltk
     #   pip-tools
+colorama==0.4.5
+    # via
+    #   build
+    #   click
+    #   pytest
+    #   tox
+commonmark==0.9.1
+    # via rich
 distlib==0.3.1
     # via virtualenv
 filelock==3.0.12
     # via
     #   tox
     #   virtualenv
+flake8==5.0.4
+    # via -r requirements/dev.in
 future==0.18.2
     # via lunr
 identify==1.5.13
@@ -42,28 +60,39 @@ markdown==3.3.3
     #   pymdown-extensions
 markupsafe==1.1.1
     # via jinja2
-mkdocs-material-extensions==1.0.1
+mccabe==0.7.0
+    # via flake8
+mkdocs==1.1.2
     # via mkdocs-material
 mkdocs-material==6.2.8
     # via
-    #   -r requirements/docs.in
+    #   -r requirements\docs.in
     #   mkdocs-material-extensions
-mkdocs==1.1.2
+mkdocs-material-extensions==1.0.1
     # via mkdocs-material
-mypy-extensions==0.4.3
-    # via mypy
 mypy==0.800
     # via -r requirements/dev.in
+mypy-extensions==0.4.3
+    # via
+    #   black
+    #   mypy
 nltk==3.5
     # via lunr
 nodeenv==1.5.0
     # via pre-commit
 packaging==20.9
     # via
+    #   build
     #   pytest
     #   tox
-pip-tools==5.5.0
+pathspec==0.10.1
+    # via black
+pep517==0.13.0
+    # via build
+pip-tools==6.8.0
     # via -r requirements/dev.in
+platformdirs==2.5.2
+    # via black
 pluggy==0.13.1
     # via
     #   pytest
@@ -74,20 +103,28 @@ py==1.10.0
     # via
     #   pytest
     #   tox
+pycodestyle==2.9.1
+    # via flake8
+pyflakes==2.5.0
+    # via flake8
 pygments==2.7.4
-    # via mkdocs-material
+    # via
+    #   mkdocs-material
+    #   rich
 pymdown-extensions==8.1.1
     # via mkdocs-material
 pyparsing==2.4.7
     # via packaging
 pytest==6.2.2
-    # via -r requirements/tests.in
+    # via -r requirements\tests.in
 pyyaml==5.4.1
     # via
     #   mkdocs
     #   pre-commit
 regex==2020.11.13
     # via nltk
+rich==12.5.1
+    # via -r requirements/dev.in
 six==1.15.0
     # via
     #   livereload
@@ -99,6 +136,11 @@ toml==0.10.2
     #   pre-commit
     #   pytest
     #   tox
+tomli==2.0.1
+    # via
+    #   black
+    #   build
+    #   pep517
 tornado==6.1
     # via
     #   livereload
@@ -109,12 +151,18 @@ tqdm==4.56.0
     # via nltk
 typed-ast==1.4.2
     # via mypy
-typing-extensions==3.7.4.3
-    # via mypy
+typing-extensions==4.3.0
+    # via
+    #   -r requirements/dev.in
+    #   black
+    #   mypy
 virtualenv==20.4.2
     # via
     #   pre-commit
     #   tox
+wheel==0.37.1
+    # via pip-tools
 
 # The following packages are considered to be unsafe in a requirements file:
 # pip
+# setuptools

{{cookiecutter.project_slug}}/requirements/docs.in

@@ -1 +1,3 @@
 mkdocs-material
+mkdocs-markdownextradata-plugin
+mkdocs-click