mitchallain / exc_analysis

Analysis tools (plotting, ML algos, kinematics) for the shared control excavator research

Python Packaging Template

Duplicate the parent directory to quickly create a working Python package that can be install in development mode with:

pip install -e /path/to/mypackage

where -e stands for --editable. This creates a symlink rather than placing the package in the standard path.

Below is a condensed version of this site

Steps to Lay out the project

• Name the project and modify both directories pytemplate/ and pytemplate/pytemplate/ to reflect the name.
• Update the setup.py metadata file
  • name, you may want this to be unique on the Python Package Index (PyPI), if you plan to share it later on PyPI
  • version, see semantic versioning
  • packages describes where you've put the source code
• Add an appropriate LICENSE.txt file
• Update the README.md file
• If your project is already fairly well-developed, see 'Arranging your file and directory structure'
• Otherwise, continue on

Create first release

• Use version 0.1dev to indicate a dev version.
• When ready to release, run:

$ python setup.py sdist

to create a tarball of the source code in the dist directory of the project continue here later

Register your package with PyPI

References

[1] The Hitchhiker's Guide to Packaging