Prompts

When you create a package, you are prompted to enter these values.

Templated Values

The following appear in various parts of your generated project.

full_name
Your full name.
email
Your email address.
github_username
Your GitHub username.
project_name
The name of your new Python package project. This is used in documentation, so spaces and any characters are fine here.
project_slug
The namespace of your Python package. This should be Python import-friendly. Typically, it is the slugified version of project_name.
project_short_description
A 1-sentence description of what your Python package does.
pypi_username
Your Python Package Index account username.
version
The starting version number of the package.

Options

The following package configuration options set up different features for your project.

use_pytest
Whether to use pytest for testing.
use_pypi_deployment_with_travis
Whether to use PyPI deployment with Travis.
add_pyup_badge
Whether to add the PyUp badge in the README file.
command_line_interface
Whether to create a console script using Click. Console script entry point will match the project_slug. Options: [‘Click’, “No command-line interface”]
create_author_file
Whether to create an AUTHORS.rst file.
open_source_license
What license will be used for the package. Options: [“MIT license”, “BSD license”, “ISC license”, “Apache Software License 2.0”, “GNU General Public License v3”, “Not open source”]