Cookiecutter Python Package

With Cookiecutter Python Package, you can create your Python packages with a professional structure and with a lot of resources available.

Pypkg Cookiecutter is a template inspired by the Cookiecutter Pypackage.

Requirements

Required	Required version	How to verify	How to install
Git	>= 2.25.0	`git --version`	Git
Python	>= 3.8	`python --version`	Python
Black	>= 19.10b0	`black --version`	Black
Cookiecutter	>= 1.7	`cookiecutter --version`	Cookiecutter
Pip	>= 20.0.2	`pip --version`	Pip
*Poetry	>= 1.0.5	`poetry --version`	Poetry

* If chosen at creation

Using:

$ pip install cookiecutter --user
$ cookiecutter https://github.com/williamcanin/cookiecutter-python-package.git

After that, go to the folder with the name of the project that you entered at the time of the questions. Example:

$ cd my_package

Create the virtual machine, activate it and install the requirements:

$ python -m venv venv
$ . venv/bin/activate
$ pip install --upgrade pip
$ pip install -r requeriments_dev.txt requeriments.txt

Create the virtual machine, activate it and install the requirements using Poetry:

$ poetry shell
$ poetry install

There, you can start to develop your Python package.

Developers of Cookiecutter Python Package

If you want to build something more in this project, prepare the environment like this:

$ git clone https://github.com/williamcanin/cookiecutter-python-package.git
$ cd cookiecutter-python-package
$ python -m venv venv
$ . venv/bin/activate
$ pip install --upgrade pip
$ pip install -r requirements.txt

Tests