Skip to content

CookieCutter Templates for Python / Django packages/projects

License

Notifications You must be signed in to change notification settings

jedie/cookiecutter_templates

Repository files navigation

cookiecutter templates

tests codecov

All Templates are tested via unittests!

Patches welcome!

uv based python package with a Makefile

  • Requirement management with uv
  • Makefile with a simple "help" menu
  • used pyproject.toml for everything
  • Base requirements are only: python3-venv and python3-pip (uv will ne installed via pip in .venv)
  • Has basic unittest

Cookiecutter template tests are here: make-uv-python/tests.py

Use with vanilla cookiecutter, e.g.:

cookiecutter https://github.com/jedie/cookiecutter_templates/ --directory make-uv-python

Use with manageprojects, e.g.:

./cli.py start-project https://github.com/jedie/cookiecutter_templates/ --directory make-uv-python ~/foobar/

Django Project

  • Requirement management with pip-tools:
    • Used pip-compile to freeze/pin requirements with hashes
    • Used pip-sync to install all needed packages
  • manage_django_project:
    • Auto virtualenv bootstrap, just by calling the manage.py
    • Dev. managed commands
  • used pyproject.toml for everything

Cookiecutter template tests are here: managed-django-project/tests.py

Use with vanilla cookiecutter, e.g.:

cookiecutter https://github.com/jedie/cookiecutter_templates/ --directory managed-django-project

Use with manageprojects, e.g.:

./cli.py start-project https://github.com/jedie/cookiecutter_templates/ --directory managed-django-project ~/foobar/

pipenv based python package

  • Requirement management with pipenv
  • Makefile with a simple "help" menu
  • used pyproject.toml for everything
  • Has basic unittest

Cookiecutter template tests are here: pipenv-python/tests.py

Use with vanilla cookiecutter, e.g.:

cookiecutter https://github.com/jedie/cookiecutter_templates/ --directory pipenv-python

Use with manageprojects, e.g.:

./cli.py start-project https://github.com/jedie/cookiecutter_templates/ --directory pipenv-python ~/foobar/

pip-tools based python package

  • Requirement management with pip-tools:
    • Used pip-compile to freeze/pin requirements with hashes
    • Used pip-sync to install all needed packages
  • click based CLI for app and dev mode
  • Auto virtualenv bootstrap, just by calling the cli.py / dev-cli.py
  • used pyproject.toml for everything
  • Has basic unittest

Cookiecutter template tests are here: piptools-python/tests.py

Use with vanilla cookiecutter, e.g.:

cookiecutter https://github.com/jedie/cookiecutter_templates/ --directory piptools-python

Use with manageprojects, e.g.:

./cli.py start-project https://github.com/jedie/cookiecutter_templates/ --directory piptools-python ~/foobar/

uv based python package

  • Requirement management with uv
  • click based CLI for app and dev mode
  • Auto virtualenv bootstrap, just by calling the cli.py / dev-cli.py
  • used pyproject.toml for everything
  • Base requirements are only: python3-venv and python3-pip (uv will ne installed via pip in .venv)
  • Has basic unittest

Cookiecutter template tests are here: uv-python/tests.py

Use with vanilla cookiecutter, e.g.:

cookiecutter https://github.com/jedie/cookiecutter_templates/ --directory uv-python

Use with manageprojects, e.g.:

./cli.py start-project https://github.com/jedie/cookiecutter_templates/ --directory uv-python ~/foobar/

Base Django YunoHost app

YunoHost is a Open-Source, Debian based self-hosting solution.

This CookieCutter template is useful to build a YunoHost App for a Django based Web application

  • Contains all YunoHost scripts for install, backup, restore etc. action
  • Used django_yunohost_integration
  • Requirement management with pip-tools
  • click based CLI
  • Auto virtualenv bootstrap, just by calling dev-cli.py
  • used pyproject.toml for everything
  • Project unittest with Django integration tests

Cookiecutter template tests are here: yunohost_django_package/tests.py

Use with vanilla cookiecutter, e.g.:

cookiecutter https://github.com/jedie/cookiecutter_templates/ --directory yunohost_django_package

Use with manageprojects, e.g.:

./cli.py start-project https://github.com/jedie/cookiecutter_templates/ --directory yunohost_django_package ~/foobar/

contribute

setup local test enviorment

~$ git clone https://github.com/jedie/cookiecutter_templates.git
~$ cd cookiecutter_templates
~/cookiecutter_templates$ ./cli.py --help

The output of ./cli.py --help looks like:

Usage: ./cli.py [OPTIONS] COMMAND [ARGS]...

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
│ --help      Show this message and exit.                                                          │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮
│ fix-file-content       Unify cookiecutter variables in file content. e.g.: "{{foo}}" -> "{{ foo  │
│                        }}"                                                                       │
│ fix-filesystem         Unify cookiecutter variables in the file/directory paths. e.g.:           │
│                        "/{{foo}}/{{bar}}.txt" -> "/{{ foo }}/{{ bar }}.txt"                      │
│ reverse                Reverse a /generated_templates/<pkg_name>/ back to Cookiecutter template  │
│                        in: ./<pkg_name>/                                                         │
│ templates2generated    Generate all cookiecutter templates                                       │
│ update-readme-history  Update project history base on git commits/tags in README.md              │
│ update-template-req    Update requirements of all cookiecutter templates                         │
│ version                Print version and exit                                                    │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯

Run tests, e.g.:

~/cookiecutter_templates$ ./cli.py test

# or sub tests:
~/cookiecutter_templates$ ./cli.py test managetemplates/tests/test_piptools_python.py

# It's just a "python3 -m unittest" wrapper cli, see:
~/cookiecutter_templates$ ./cli.py test --help

The dev. CLI

Usage: ./dev-cli.py [OPTIONS] COMMAND [ARGS]...

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
│ --help      Show this message and exit.                                                          │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮
│ check-code-style            Check code style by calling darker + flake8                          │
│ coverage                    Run tests and show coverage.                                         │
│ fix-code-style              Fix code style of all managetemplates source code files via darker   │
│ install                     Install requirements and 'managetemplates' via pip as editable.      │
│ mypy                        Run Mypy (configured in pyproject.toml)                              │
│ pip-audit                   Run pip-audit check against current requirements files               │
│ publish                     Build and upload this project to PyPi                                │
│ test                        Run unittests                                                        │
│ tox                         Run tox                                                              │
│ update                      Update "requirements*.txt" dependencies files                        │
│ update-test-snapshot-files  Update all test snapshot files (by remove and recreate all snapshot  │
│                             files)                                                               │
│ version                     Print version and exit                                               │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯

History

  • v0.5.0
    • 2024-12-03 - Use new cli_base
    • 2024-12-03 - Remove tyro work-a-round
    • 2024-11-21 - Replace click by tyro in uv-python
    • 2024-11-14 - New template: "make-uv-python"
    • 2024-11-13 - Migrate to uv
    • 2024-11-13 - Bugfix uv-python
    • 2024-10-29 - Add "uv-python" template
    • 2024-09-26 - Move pip-compile settings into pyproject.toml + create pywheel hashes
    • 2024-09-26 - Add "setup Python" to YunoHost template
    • 2024-09-25 - Simplify: Use update_readme_history() from cli-base-utilities
    • 2024-09-25 - Bugfix github CI matrix: "3.13" is only available via RC... Skip it until release.
    • 2024-09-25 - Apply own project updates from own template ;)
    • 2024-09-25 - Bugfix "pre-commit" call
    • 2024-09-25 - Updates for "piptools-python" template:
    • 2024-09-22 - Move pip-compile settings into pyproject.toml and add piwheels hashes
    • 2024-09-09 - Update YunoHost package: reuse existing venv and use pip-sync
    • 2024-09-07 - Update YunoHost template
    • 2024-09-05 - update manage-django-project
    • 2024-09-05 - Update template requirements and some min. Python specification
    • 2024-09-05 - "bin/python" -> "bin/python3"
    • 2024-09-05 - Enhance output and use EncloseRuleContext or Rule
    • 2024-08-30 - Add docstring link to "version-specifiers"
    • 2024-08-30 - CLIs: catch KeyboardInterrupt
    • 2024-08-30 - Update yunohost_django_package
    • 2024-08-25 - Update yunohost_django_package from https://github.com/YunoHost-Apps/django-for-runners_ynh
    • 2024-08-25 - Use typeguard in tests
    • 2024-08-25 - Use always "python3" instead of "python"
    • 2024-08-25 - Work-a-round for: jazzband/pip-tools#1866
    • 2024-08-25 - Remove poetry based templates!
    • 2024-08-25 - Update requirements + CI config + test matrix
    • 2024-08-02 - Finalize replace "safety" by "pip-audit
    • 2024-08-02 - Replace safety with pip-audit
    • 2024-07-16 - Always pip and pip-tools if updates are needed
    • 2024-07-09 - pipenv-python: Move requirements into pyproject.toml
    • 2024-07-08 - Update pipenv-python template
    • 2024-05-21 - Ignore safety #67599
    • 2024-03-12 - Split CLI
    • 2024-03-12 - piptools-python: Split CLI into app/dev CLI packages
    • 2024-03-12 - Update requirements
    • 2024-03-12 - Use @cli.command()
    • 2024-02-29 - update template requirements
    • 2024-02-29 - remove obsolete darker options + update requirements
    • 2024-01-16 - Move typeguard install_import_hook
    • 2024-01-16 - piptools-python: Add typeguard
    • 2023-12-29 - piptools-python: Still support Python v3.9
    • 2023-12-22 - -MAP_DOWNLOAD
    • 2023-12-22 - +[*.{html,css,js}]
    • 2023-12-22 - Exclude "dist" directory
    • 2023-12-22 - Update managed-django-project
  • v0.3.0
    • 2023-12-21 - Update manageprojects updates
    • 2023-12-21 - gitignore: +/build/
    • 2023-12-21 - Unify BASE_PATH / PACKAGE_ROOT etc.
    • 2023-12-21 - fix darker + Django v5.0 + Python >=3.10
    • 2023-12-21 - managed-django-project fix missing placeholders
    • 2023-12-21 - managed-django-project: Min. Python v3.10
    • 2023-12-21 - {{ cookiecutter.package_name }}_project -> {{ cookiecutter.django_project_name }}
    • 2023-12-03 - yunohost_django_package: project setup updates
    • 2023-12-03 - yunohost_django_package: Update requirements
    • 2023-12-17 - Update django test matrix: Add v5.0 and remove v4.1
    • 2023-12-17 - Copy all requirements files back
    • 2023-12-17 - Bugfix CI: Checkout all for darker
    • 2023-12-17 - Github CI: Include all requirements files into cache dependency
    • 2023-12-17 - Github CI: Display warnings only for test run step
    • 2023-12-17 - Configure unittests via "load_tests Protocol"
    • 2023-12-17 - Update requirements
    • 2023-12-17 - remove unused .../tests/utils.py file
    • 2023-12-17 - Django projects: AUTOLOGIN in local env as default
    • 2023-12-16 - editorconfig: Add "*.yaml"
    • 2023-12-02 - Use tools from cli_base
    • 2023-12-01 - Bugfix local tox run
    • 2023-12-01 - Update piptools-python template
    • 2023-11-30 - WIP: piptools-python updates
    • 2023-11-30 - DjangoYnhTestCase better error messages
    • 2023-11-30 - update requirements and add "flake8-bugbear"
    • 2023-11-28 - django prijects: cleanup settings
    • 2023-11-26 - Cleanup YunoHost app tests
    • 2023-11-26 - Yunohost Package: Remove pytest and use normal unittests
    • 2023-11-25 - DEBUG_ENABLED "YES" / "NO" -> "1" / "0"
    • 2023-11-25 - Update generated yunohost template
    • 2023-11-25 - ynh package: debug_enabled: type = "boolean"
    • 2023-11-25 - ynh package: Comment "website" link.
    • 2023-11-25 - ynh package: doc/{DISCLAIMER.md => ADMIN.md}
    • 2023-11-25 - Small updates
    • 2023-11-25 - YunoHost package: Nicer Links in README to CI services
    • 2023-11-09 - fix yunohost_django_package snapshot test
    • 2023-11-09 - Update and run yunohost_django_package/update_requirements.py
    • 2023-11-09 - Update template requirements
    • 2023-11-09 - Add beautifulsoup4 because of html snapshot test
    • 2023-11-09 - Fix version check
    • 2023-11-09 - Update generated_templates/yunohost_django_package
    • 2023-11-09 - YunoHost Template: Add "config_panel.toml" with work-a-round.
    • 2023-11-09 - Add indirect depencies as work-a-round
    • 2023-11-09 - YunoHost template: pytest: disable_warnings = ["couldnt-parse"]
    • 2023-11-09 - YunoHost template: Check github only if version checks passed before
    • 2023-11-09 - YunoHost template: Snapshot the page
    • 2023-11-09 - YunoHost template: fix CI
    • 2023-11-09 - fix yunohost template
    • 2023-11-01 - Yunohost Django Package cleanup "poetry -> pip-tools" migration
    • 2023-11-01 - Yunohost Django package: Replace Poetry with pip-tools
    • 2023-11-01 - git ignore: +*.orig
    • 2023-10-08 - Bugfix pipenv template (darker extras)
    • 2023-10-08 - Add Python v3.12
    • 2023-08-22 - Update YunoHost test for new manifest v2 file
    • 2023-08-22 - Remove obsolete YunoHost config files
    • 2023-08-21 - Update YunoHost Django Package template to "Manifest v2"
    • 2023-08-22 - Update poetry-django-app
    • 2023-08-22 - +/coverage.*
    • 2023-08-17 - Don't exist cmd2 shell on "Interrupt from keyboard"
    • 2023-08-17 - Use argument to call the CLI entry point
    • 2023-08-17 - Bugfix Python 3.9 compatibility
    • 2023-08-17 - Migrate to cli_base.cli_tools.git and cli_base.cli_tools.version_info
    • 2023-08-17 - Bugfix yunohost_django_package
    • 2023-08-17 - Use cli-base-utilities and template updates and bugfixes
    • 2023-08-05 - split CLI
    • 2023-08-05 - Bugfix github actions for piptools-python
    • 2023-06-11 - update requirements and fix "tomli"
    • 2023-05-07 - Split piptols-python cli: "cli.py" and "dev-cli.py"
    • 2023-04-13 - Refactor yunohost_django_package context
    • 2023-04-10 - Add "project_name" to managed-django-project template
    • 2023-04-10 - remove snapshot test ;)
    • 2023-04-10 - Update requirements in templates
    • 2023-04-10 - use the real URl to https://github.com/jedie/django_example
    • 2023-04-10 - Update django_example.version in yunohost_django_package/cookiecutter.json
    • 2023-04-10 - Dev (#65)
    • 2023-04-10 - templates2generated: force recreate as default (#64)
    • 2023-04-10 - Enhance managed-django-project (#61)
    • 2023-04-10 - Hacky way to expand the failed test output (#62)
    • 2023-04-10 - +license = "{{ cookiecutter.license }}" (#60) (#63)
    • 2023-04-07 - +license = "{{ cookiecutter.license }}" (#60)
    • 2023-04-06 - WIP: add generated template into repository (#54)
    • 2023-04-05 - Udpate managed-django-project to manage_django_project v0.3.0
    • 2023-04-04 - NEW: "managed-django-project" template (#59)
    • 2023-04-04 - Dev (#58)
    • 2023-04-04 - Update yunohost_django_package template (#57)
    • 2023-04-02 - Add setuptools_scm to include all files from git repository (#56)
    • 2023-04-02 - fix poetry-python
    • 2023-04-02 - Fix darker/flynt/isort/Pygments combination
    • 2023-03-17 - Update templates (#53)
    • 2023-03-17 - Use: dynamic = ["version"] (#52)
    • 2023-03-07 - Run DocTests via helper from bx_py_utils (#51)
    • 2023-03-06 - Coverage2 (#50)
    • 2023-03-06 - Bugfix link to codecov.io (#49)
    • 2023-03-06 - Py 3.11 tomllib vs. tomli (#48)
    • 2023-03-06 - Updates
    • 2023-03-06 - unify github action configs
    • 2023-03-06 - fix coverage setup
    • 2023-02-20 - Tox (#44)
    • 2023-02-19 - replace "coveralls" with "coverage" (#43)
    • 2023-02-19 - piptools-python: Replace typer CLI with click and add flynt to darker (#42)
    • 2023-02-19 - Update poetry-django-app (#41)
    • 2023-02-19 - Update via manageprojects (#40)
    • 2023-02-19 - Dev (#39)
    • 2023-02-18 - Dev (#38)
    • 2023-02-18 - add "make install-base-req" target to install needed OS base packages (#37)
    • 2023-02-07 - Update .flake8
    • 2023-02-07 - Cleanup Makefiles (#36)
    • 2023-02-07 - Update pythonapp.yml
    • 2023-02-07 - Add a reuseable Django App (#35)
    • 2023-02-05 - Bugfix cli and tests
    • 2023-02-05 - Bugfix publish test
    • 2023-02-05 - Bugfix tests and capture logs
    • 2023-02-05 - Bugfix excludes
    • 2023-02-05 - Change CLI from typer to click
    • 2023-02-05 - fix code style
    • 2023-02-05 - Apply "fix-file-content"
    • 2023-02-05 - Add "fix-file-content" CLI command to unify Cookiecutter vars in file contents
    • 2023-02-05 - fix tests
    • 2023-02-05 - Force unique var syntax in filesystem path by unittest
    • 2023-02-05 - Apply "fix-filesystem"
    • 2023-02-05 - Add "fix-filesystem" CLI command to rename e.g.: "/{{foo}}/{{bar}}.txt" -> "/{{ foo }}/{{ bar }}.txt"
    • 2023-01-25 - Dev (#31)
    • 2023-01-13 - Fix github actions
    • 2023-01-13 - Move test files to the templates
    • 2023-01-13 - poetry-python: Refactor tox setup
    • 2023-01-12 - Update DocString, too.
    • 2023-01-12 - "http://" -> "https://"
    • 2023-01-12 - piptools-python: rename extras from "tests" to "dev"
    • 2023-01-11 - Don't check Github version while running in GitHub actions
    • 2023-01-10 - Update piptools-python and code style fix+lint
    • 2023-01-10 - Bugfix poetry-python template
    • 2023-01-10 - NEW: Reverse a /.tests/<pkg_name>/ back to Cookiecutter template in: ./<pkg_name>/
    • 2023-01-10 - Enhance CLI and code style linting + fixing
    • 2023-01-10 - constants.TEST_PATH
    • 2023-01-10 - Remove "[tool.flake8]" because it's unsupported, yet.
    • 2023-01-10 - Enhance poetry-python template
    • 2023-01-10 - Use constants.ALL_TEMPLATES
    • 2023-01-10 - Test if dir exists
    • 2023-01-09 - Use a more relaxed flak8 exclude rule
    • 2023-01-08 - update requirements (#22)
    • 2023-01-08 - Doc strings: fix github link to darker project
    • 2022-12-30 - Refactor "dependencies" definition
    • 2022-12-30 - [tool.setuptools] -> include all packages (#18)
    • 2022-12-30 - poetry-python: Use rich print and add "version" command
    • 2022-12-30 - set max line length to 119
    • 2022-12-30 - pipenv-python: add .flake8
    • 2022-12-30 - fix gitignore
    • 2022-12-30 - .editorconfig *.yml == indent_size = 2
    • 2022-12-30 - Nicer Typer init
    • 2022-12-30 - Enhance default test run and piptools-python project
    • 2022-12-30 - Delete coverage.json
    • 2022-12-21 - Update test_project_setup.py
    • 2022-12-21 - Update settings.py
    • 2022-12-21 - Update pyproject.toml
    • 2022-12-21 - borrow package linter from homeassistant_ynh
    • 2022-12-21 - yunohost_django_package: Check code style in tests
    • 2022-12-21 - yunohost_django_package: remove pytest-darker
    • 2022-12-21 - yunohost_django_package: Add "3.11" to test matrix
    • 2022-12-21 - piptools-python: Use new pip-compile resolver
    • 2022-11-30 - Expand test timeouts
    • 2022-11-30 - Add "dynamic" README with all existing templates
    • 2022-11-21 - Fix "yunohost_django_package" tests
    • 2022-11-21 - Bugfix "yunohost_django_package" code style
    • 2022-11-21 - Bugfix "yunohost_django_package" context
    • 2022-11-21 - Add work-a-round for "poetry install" bug
    • 2022-11-20 - Work-a-round for jazzband/pip-tools#994 (comment)
    • 2022-11-20 - Enhance Github CI config
    • 2022-11-20 - +[tool.coverage.report]
    • 2022-11-20 - isort "skip_glob": add ".*"
    • 2022-11-20 - +pip-tools
    • 2022-11-20 - Update pip first
    • 2022-11-20 - update READMEs
    • 2022-11-20 - Update README.md
    • 2022-11-20 - fix darker
    • 2022-11-20 - Compile "piptools-python" requirements on "update" command, too.
    • 2022-11-20 - Use Git and subprocess_utils from manageprojects
    • 2022-11-20 - install() after update is not needed, because the bootstrap will does this.
    • 2022-11-20 - More tests for cli
    • 2022-11-20 - applied migrations "68124d4"
    • 2022-11-19 - fix github action
    • 2022-11-19 - remove unused file
    • 2022-11-19 - Add github CI file to "piptools-python" template
    • 2022-11-19 - Switch from poetry to piptool template
    • 2022-11-19 - Delete .coverage
    • 2022-11-19 - Add CLI to piptools-python template and add basic tests
    • 2022-11-19 - rename "minimal-python" to "piptools-python"
    • 2022-11-19 - fix isort + flake8
    • 2022-11-19 - Template + test updates
    • 2022-11-15 - Bugfix missing new Version
    • 2022-11-15 - Bugfix wrong CI workflow file
    • 2022-11-15 - Start testing
    • 2022-11-15 - start adding tests
    • 2022-11-14 - fix flake8 call
    • 2022-11-14 - +tomli
    • 2022-11-14 - bugfix and expand "poetry-python" template
    • 2022-11-14 - fix template
    • 2022-11-14 - Add a cli and CI setup
    • 2022-11-13 - Work-a-round for pypa/setuptools#3278
    • 2022-11-13 - bugfix poetry template
    • 2022-11-13 - Add poetry-python template
    • 2022-11-13 - use importlib.metadata.version
    • 2022-11-10 - add a pipenv-python template
    • 2022-11-10 - fix make update-requirements
    • 2022-11-10 - remove pytest
    • 2022-11-10 - add minimal-python
    • 2022-11-10 - Bugfix: Create PEP 440 version
    • 2022-11-06 - "{{cookiecutter.author_name}}" -> "{{cookiecutter.full_name}}"
    • 2022-11-06 - {{cookiecutter.upstream_pkg_name}}_ynh -> {{cookiecutter.ynh_app_pkg_name}}
    • 2022-11-06 - -upstream_name +upstream_pkg_name
    • 2022-11-06 - remove lock file
    • 2022-11-06 - Bugfix unable to create file '.github/workflows/pytest.yml'
    • 2022-11-06 - Add yunohost_django_package
    • 2022-11-04 - Initial commit

Links

About

CookieCutter Templates for Python / Django packages/projects

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published