Skip to content

Curly-Mo/fresh-baked

Repository files navigation

Fresh Baked

Build Status License

A modern python cookiecutter template

PEP518 approved pyproject.toml, let's start using it for new projects.
poetry is the most well-developed tool so far utilizing pyproject.toml for dependency management, package building, and publishing.
Together they can fully replace the need for setup.py, setup.cfg, pipenv, requirements.txt, bumpversion, twine...

See an example of what this cookiecutter creates: https://github.com/Curly-Mo/fresh-baked-skeleton

Features

  • Use poetry to manage dependencies in pyproject.toml and deploy to PyPi.
  • Choose License: GPL, MIT, BSD, ISC, Apache
  • isort, black: code formatting
  • Pylint, Flake8: code style
  • pytest: unit testings
  • pytest-cov: test coverage reports
  • tox: for managing tests
  • Click for CLI scripts
  • Badges for Travis, Coveralls, ReadtheDocs, PyPi
  • Travis-CI: continuous integration
  • Coveralls: CI coverage reporting
  • Sphinx docs: Documentation ready for generation and publication to ReadtheDocs

Usage

pip install cookiecutter
cookiecutter https://github.com/Curly-Mo/fresh-baked

Setup integration services

Push to GithHub

git commit -m 'intial files'
git remote add origin https://github.com/<github_username>/<github_repo_name>.git
git push origin master

Watch as your badges turn 💚green💚

Begin development

pip install poetry
poetry install

Tests

poetry run tox

Deploy to PyPi

poetry build
poetry publish

About

A modern python cookiecutter template

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published