Skip to main content

A commandline interface for creating project structures

Project description

PyPI version

project_cli

A commandline interface for creating structured Python projects.

Installation

pip install project_cli

Usage

python -m project_cli

If you trust project_cli to make the right decisions, you can say ‘yes’ to all prompts:

python -m project_cli -y

Detailed information

Here is an example project structure created by this tool for a runnable project:

> proj_name
    __init__.py
    __main__.py
> tests
    __init__.py
    context.py
    test_main.py
README.rst
setup.py

You can run your app as follows:

python -m proj_name

You can run tests as follows:

python -m unittest discover tests

You can also install your project in your own pip repository (or in a virtual environment) to make it runnable anywhere on your system:

pip install -e .

Note: the -e flag is optional. It will keep your pip repository synchronized with your source code.

Meta

Ramon Hagenaars - ramon.hagenaars@gmail.com

This structure was inspired by Kenneth Reitz.

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

project_cli-0.1.1.tar.gz (3.6 kB view hashes)

Uploaded source

Built Distribution

project_cli-0.1.1-py3-none-any.whl (4.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page