README.md

wemake-python-package

Bleeding edge cookiecutter template to create new python packages.

---

Purpose

This project is used to scaffold a python project structure. Just like poetry new but better.

Features

• Always up-to-date dependencies with the help of @dependabot
• Supports latest python3.8+
• poetry for managing dependencies
• mypy for optional static typing
• pytest for testing
• flake8 and wemake-python-styleguide for linting
• Github Actions as the default CI
• sphinx and readthedocs.org for documentation
• Easy update process, so your template will always be up-to-date

Installation

Firstly, you will need to install dependencies:

pip install cookiecutter jinja2-git lice

Then, create a project itself:

cookiecutter gh:wemake-services/wemake-python-package

In order for the github actions to work smoothly (ie badge), you must, during the setup, use your github username in the organization field.

project_name [my-awesome-project]: foo-project
organization [wemake.services]: <github_username>

Projects using it

Here's a nice list of real-life open-source usages of this template.

License

MIT. See LICENSE for more details.