rozelie / python_cookiecutter Public

Notifications You must be signed in to change notification settings
Fork 0
Star 0

My personal Python project cookiecutter template tailored to my own preferences.

0 stars 0 forks Branches Tags Activity

Name		Name	Last commit message	Last commit date
Latest commit History 41 Commits
scripts		scripts
{{cookiecutter.project_slug}}		{{cookiecutter.project_slug}}
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
cookiecutter.json		cookiecutter.json

Repository files navigation

Python Cookiecutter

My personal Python project cookiecutter template tailored to my own preferences.

Features

Python 3.11
feature-rich scripts dir
- scripts/setup: setup the local environment
- scripts/run: run the app locally
- scripts/format: format source code
- scripts/lint: lint source code
- scripts/test: run tests
- scripts/docker_build: build a docker image for the app
- scripts/docker_run: run a docker container for the app
- scripts/publish_to_pypi: publish the package to pypi.org
pyproject.toml based
Dockerized
Github Action to run CI
MIT license
Python-specific .gitignore

Usage

pip install cookiecutter
cookiecutter https://github.com/rozelie/python_cookiecutter

Local Testing

./scripts/setup
./scripts/test

Resources

Todo

Add Dockerfile.dev functionality
Add logging.ini or similar
Add optional functionality:
- SQLAlchemy, Postgres integration
- docker compose file
- FastAPI, domain-based
- Alembic
  - Add target to create a new alembic revision (if using alembic)