Quickstart¶

See Reference Project Inputs for all information collected to create a new cookiecutter-py3-package.

Create a GitHub Repository¶

Your new GitHub repository information is required to generate your cookiecutter-py3-package in these steps.

project_name¶

The name of your new cookiecutter-py3-package, used in the documentation, so spaces and any characters are acceptable here.

Typically the repository name in sentence form.

project_short_description¶

A sentence describes your cookiecutter-py3-package.

Typically the repository description.

Create Virtual Environment¶

Select the tab for your preferred Operating System.

Linux

bash/zsh¶

python3 -m venv venv
source venv/bin/acivate
pip install --upgrade pip

You will have a folder structure similar to this.

packages
└── venv

macOS

bash/zsh¶

python3 -m venv venv
source venv/bin/acivate
pip install --upgrade pip

You will have a folder structure similar to this.

packages
└── venv

Windows

If you have installed Python in your PATH and PATHEXT.

cmd/PowerShell¶

python3 -m venv venv

C:\> venv\Scripts\activate.bat  # cmd.exe
PS C:\> venv\Scripts\Activate.ps1 # Powershell

pip install --upgrade pip

Otherwise use

cmd/PowerShell¶

c:\>c:\Python36\python -m venv c:\path\to\packages\my_env
PS C:\> <venv>\Scripts\Activate.ps1

C:\> venv\Scripts\activate.bat  # cmd.exe
PS C:\> venv\Scripts\Activate.ps1 # Powershell

pip install --upgrade pip

You will have a folder structure similar to this.

packages
└── venv

Install Cookiecutter¶

Firstly it’s advisable to upgrade pip using the following command.

Linux, macOS and Windows¶

pip install --upgrade pip

You will see something like this in your CLI.

Requirement already satisfied: pip in ./my_env/lib/python3.9/site-packages (21.2.3)
Collecting pip
 Using cached pip-21.2.4-py3-none-any.whl (1.6 MB)
Installing collected packages: pip
  Attempting uninstall: pip
    Found existing installation: pip 21.2.3
    Uninstalling pip-21.2.3:
      Successfully uninstalled pip-21.2.3
Successfully installed pip-21.2.4

Install cookiecutter into your virtual environment.

Linux, macOS and Windows¶

pip install cookiecutter

Start Cookiecutter-Py3-Package¶

In your packages folder, use the following command.

Linux, macOS and Windows¶

cookiecutter https://github.com/imAsparky/cookiecutter-py3-package

Cookiecutter will ask questions to set your package up. If you’re unsure or don’t know what to enter, stick with the defaults.

See Reference-Inputs for more details about the cookiecutter-py3- project options.

packages
    ├── venv
    └── my-new-package

Install Dependencies¶

Change into your project directory.

cd <your my-new-package folder>

Install dependencies.

pip install -r requirements_dev.txt

Congratulations, you have created your new Python Package.

Depending on your chosen options, there are several ways to proceed with pushing to GitHub. If you are unsure, see our git push tutorial for more information.