Create the file and folder structure for a Python package
Project description
create-python-package
Overview
Initialize a new package using best practices as described by the Python Packaging Authority (PyPA). Perfect for beginners and experts alike. Stop writing boilerplate and start coding.
Generates a project similar to the Python Packaging Authority's sample project, but with various parts autogenerated based on your inputs.
Features
- Creates a battle-tested directory structure with boilterplate for unit tests, license,
setup.py
and more - Sets you up with popular Python environment managers such as venv and Pipenv
- Initializes a git repository for you with a .gitignore file
Usage
This package ships with one CLI entrypoint, create-python-package
.
To interactively answer questions about your project, such as author, license, etc.
$ create-python-package
You will then be prompted with questions such as
question version (0.0.0.1):
question description ():
question entry point (main.py):
question repository url ():
question author (Your Name):
question email (email@doman.com):
question environment management (venv) (options: venv, pipenv, poetry):
question license (mit) (options: mit, gplv3, apache2, bsd3):
These are used to populate setup.py and other files to give you as painless experience as possible when starting a new project.
To use defaults and skip interactive prompts, use the --yes
flag
$ create-python-package --yes
Installation
Python 3.6+ is required
using pip
pip install --user create-python-package
using pipx
pipx allows you to run Python binaries directly, or install packages into isolated virtual environments and add their binaries to your PATH
pipx run create-python-package
or install with
pipx install create-python-package
Credits
Inspired by create-react-app
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for create-python-package-0.2.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 995ed11d0663e4249789d226b7b69b893d082bde0686c25a07c729985537e6bf |
|
MD5 | bdea85a1d644240a25795ca83cf41032 |
|
BLAKE2b-256 | 12531cdb6b54675942bd6aaa05cc0fd5b8b615f767a921e10f750fd7e901ecd3 |
Hashes for create_python_package-0.2.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7382b0420ced75f4e31926baad29876153b19a3bd7a6f944a1639c0e8ce05b6a |
|
MD5 | bc46c5d825fdb890fa04872584c02693 |
|
BLAKE2b-256 | f2eba3656cad42f55454f3a502c6a1524e16ce049ad734f9f2d5771ef2702016 |