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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file create-python-package-0.0.0.1.tar.gz.

File metadata

  • Download URL: create-python-package-0.0.0.1.tar.gz
  • Upload date:
  • Size: 2.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.27.0 CPython/3.6.2+

File hashes

Hashes for create-python-package-0.0.0.1.tar.gz
Algorithm Hash digest
SHA256 63dcd19b3e66bf529594ac3d51c18d1be113ce182a552289b29de5f5f384bbac
MD5 aba6b3a98f80756dadb626e50b307142
BLAKE2b-256 c30ca9cf4998817d3e7e4b647e23398f0dd147e369532e64a48211441c4cc851

See more details on using hashes here.

File details

Details for the file create_python_package-0.0.0.1-py3-none-any.whl.

File metadata

  • Download URL: create_python_package-0.0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 3.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.27.0 CPython/3.6.2+

File hashes

Hashes for create_python_package-0.0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e55450ce7e58b151199fc8bd02d34f9493b78ef0bf268a02e15c9802098a8cc7
MD5 41f291948a8fac930c020335ec2de648
BLAKE2b-256 b47fa1edfada5f7f5f6e3eac89e66b536d8481b48cf9acf07b61b5d5d6d07587

See more details on using hashes here.

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