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

.github/dependabot.yml

@@ -0,0 +1,8 @@
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "{{cookiecutter.project_slug}}/requirements"
+    schedule:
+      interval: "weekly"

README.md

@@ -1,26 +1,34 @@
-# 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
 
 Install cookiecutter.
 
 ```bash
-$ pip install --user cookiecutter
+pip install --user cookiecutter
 ```
 
 Generate your project template using cookiecutter.
 
 ```bash
-$ cookiecutter gh:yankeexe/cookiecutter-python-cli
+cookiecutter gh:ltpitt/cookiecutter-python-cli
 ```
 
 ## Project Setup
@@ -30,35 +38,47 @@ $ cookiecutter gh:yankeexe/cookiecutter-python-cli
 2. Create a virtual environment.
 
 ```bash
-$ make venv
+python -m venv venv
+```
+
+3. Linux / Mac - Activate it.
+
+```bash
+source venv/Scripts/activate
+```
+
+3. Windows - Activate it.
+
+```bash
+source venv/Scripts/Activate.ps1
 ```
 
-3. Activate it.
+4. Linux / Mac - Install development dependencies with editable mode to test the CLI.
 
 ```bash
-$ source venv/bin/activate
+make install
 ```
 
-4. Install development dependencies with editable mode to test the CLI.
+4. Windows - Install development dependencies with editable mode to test the CLI.
 
 ```bash
-$ make install
+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**
 >
 >  `<<cli_command>>` is the executable command you choose for your CLI during project setup.
 
 ```bash
-$ <<cli_command>> init
+<<cli_command>> init
 ```
 
 ```bash
-$ <<cli_command>> show
+<<cli_command>> hello
 ```
 
 ### Test with Docker
@@ -67,33 +87,45 @@ 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
+make docker-image
 ```
 
 2. Run the command inside the container.
 
 ```bash
-$ docker-run --rm <<cli_command>> init
+docker-run --rm <<cli_command>> init
 ```
 
 ## Documentation
 
-1. Install documentation-related dependencies.
+1. Linux / Mac - Install documentation-related dependencies.
+
+```bash
+make docs
+```
+
+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 docs
+make serve-docs
 ```
 
-2. Serve the docs locally.
+2. Windows - Serve the docs locally.
 
 ```bash
-$ make serve-docs
+mkdocs serve -f docs/mkdocs.yml
 ```
 
-## Distribution
+## Linux / Mac - Distribution
 
 > **NOTE**
 >
@@ -102,19 +134,19 @@ $ make serve-docs
 To publish you CLI to PyPI, run:
 
 ```bash
-$ make distributions
+make distributions
 ```
 
 `dist` directory will be created inside your project directory. Upload it to PyPI using:
 
 ```bash
-$ twine dist/*
+twine dist/*
 ```
 
-## Help
+## Linux / Mac - Help
 
 For help related to make commands.
 
 ```bash
-$ make help
+make help
 ```

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,11 @@
 pip-tools
 pre-commit
 tox
-mypy
 flake8
-pytest
 black
-pre-commit
+click
+typing-extensions
+rich
+pyyaml>=6.0
+py>=1.11.0
+