Scaffold for CLI apps powered by Python 🐍

Features

• Setup driven by Python Poetry and Pyenv
• Supports Python 3.11.x and 3.12.x at local development level and CI level
• Code conventions driven by Ruff and EditorConfig
• Code formatting driven by Black
• Improved error traces driven by Pretty Errors
• Dead code detection driven by Vulture
• Security checks driven by Bandit
• Compreehensive Makefile wrapping common target tasks
• Github Actions Workflow to validate checks on Pull Requests
• Ready to deploy artifacts on Pypi
• Opinionated CHANGELOG file driven by keepachangelog.com
• Renovate ready (poetry, pyenv and and Github Actions)
• Mergify ready (automated merges for Dependabot updates)
• MIT licensed

How to use

• Get this repo

• Run the companion script

$> ./scaffold <your project name>

• Add you Pypi access token - as PYPI_TOKEN - in Github Actions Secrets Manager

• Set your name and email at pyproject.toml (as author)

• Set link(s) for your project repository at pyproject.toml (homepage and repository)

• If needed, update/change Python version at pyproject.toml and for both YAML files at `.github/workflows

• If your project is open-source, update the LICENSE file

• Profit! 💯

Author

Coded by Ubiratan Soares (follow me on Mastodon)

License

The MIT License (MIT)

Copyright (c) 2020 Dotanuki Labs

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.