Table of Contents

Python - Project

About

Project in Python as describe by Python 3 - SetupTools

Properties

Name

The project name is specified in the name properties in the setup function of the setup.py file

Structure

Project are a set of file to package a package.:

More. See:

One commonly used package configuration has all the module source code in a subdirectory (often called the src layout), like this: 

├── src
│   └── mypackage
│       ├── __init__.py
│       └── mod1.py
├── setup.py
└── setup.cfg

You can set up your setup.cfg to automatically find all your packages in the subdirectory like this: 

# This example contains just the necessary options for a src-layout, set up
# the rest of the file as described above.

[options]
package_dir=
    =src
packages=find:

[options.packages.find]
where=src

Management

Configuration

See Python - setup.py

Sample

https://github.com/pypa/sampleproject

Editable Mode Installation (development mode)

The project is both installed and editable in project form. ie changes to the project source are immediately available in the staging area(s), without needing to run a build or install step after each change. The project appears to be installed, but yet is still editable from the src tree. 

cd project_home
pip install -e .
#or
pip install -e youPath

It will also:

Dependencies will be installed in the usual, non-editable mode. 

pip install -e . --no-deps

See also: develop - Deploy the project source in “Development Mode”

Documentation / Reference