Skip to main content

Create the file and folder structure for a Python package

Project description

create-python-package

Initialize a new package using best practices as described by the Python Packaging Authority (PyPA).

Perfect for beginners and experts alike!

> create-python-package mypackage

No more guesswork!

The file structure you're left with looks like this

mypackage/
├── LICENSE
├── README.md
├── activate-venv -> /private/tmp/mypackage/venv/bin/activate
├── mypackage
│   ├── __init__.py
│   └── main.py
└── setup.py

Virtualenv ready to go!

Inside the directory you can run

source activate-venv

to activate an isolated Python environment that was created specifically for that package. To deactivate it, type

deactivate

To learn more about virtual environments, see Creating Virtual Environments.

Install

My recommendation is to run the latest version of create-python-package with pipx rather than installing it and freezing the version on your system. This is because as new tools and practices are added to create-python-package, you will automatically be using them.

Install pipx.

> pipx create-python-package mypackage  # runs latest version

If you really want to install it you can.

> pipx install create-python-package

Requires Python 3.6+.

Credits

Inspired by create-react-app

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

create-python-package-0.0.0.1.tar.gz (2.3 kB view hashes)

Uploaded Source

Built Distribution

create_python_package-0.0.0.1-py3-none-any.whl (3.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page