whatdido 0.1.0

My template for creating quick python scripts.

Pyboot

This is a simple Python application template for Python projects designed to streamline your development workflow.

Features include:

• Dependency management with Poetry: https://python-poetry.org/: Poetry provides a powerful way to manage project dependencies, creating isolated environments and handling version conflicts.
• Code formatting with Black: https://black.readthedocs.io/en/stable/: Black enforces consistent, opinionated code formatting, enhancing readability and collaboration.
• Linting with Ruff: [invalid URL removed]: Ruff helps find potential bugs, stylistic issues, and maintain a clean codebase. Unit testing with Pytest: https://docs.pytest.org/en/latest/: Pytest provides a flexible and popular framework for writing and running tests that ensure your code's correctness.
• Changelog management with towncrier: https://towncrier.readthedocs.io/en/latest/: Maintain well-structured changelogs to track project changes.
• Automation script management with Node and/or Python: Streamline common tasks (e.g., building, testing, deploying) with customizable scripts.
• Pre- and post-commit sanity checks with Husky: https://typicode.github.io/husky/: Enforce quality standards at commit time to catch issues early.
• Documentation creation with MkDocs: https://www.mkdocs.org/: Easily create beautiful technical documentation for your project.

Setup

1. Create a copy of the template

gh repo create happy-bog --template [e-mail]:evannagle/whatdido.git  --private --clone

2. Install dependencies

cd happy-bog

make install

3. Rename the app

make rename

4. Run the app

make app

Which should output:

🤖 Cleaning up
rm -rf __pycache__ .pytest_cache .coverage .mypy_cache .tox .eggs .venv

🤖 Building the project
poetry install
Installing dependencies from lock file

No dependencies to install or update

Installing the current project: whatdido (0.1.0)

🤖 Running the app
poetry run whatdido
42

5. Test the app

make test

6. Review test coverage

make coverage

7. Globalize the command for use from your command line

make globalize

happy-bog

> 42