This is the protocol to follow when either initializing a Python Package for the first time or when making a release of a Python Package.
Ideally use Protemplates to create a Python package. Link to Protemplates.
- Download the appropriate binary for your system.
- Copy paste the
protemplates
binary into your/usr/local/bin
directory.
$ cd /path/to/projects-dir/
$ protemplates create python
- Update
README.md
- Travis badge
- Project description
- Current stable version
- Installation instructions for usage and development
- Usage
- Examples
- Tests
- License
- Resources
- Update
setup.py
- Short description
- Author
- Author email
- URL
- Download URL
- Python versions
- Test requires
- Install requires
- Update
dev_environment.yml
&requirements.txt
- Add
m2r
,twine
andSphinx
todev_environment.yml
only.
- Add
- Update
LICENSE
- Update
.travis.yml
- Update
__init__.py
version - Update
tests/test_basic.py
- Update
examples
- Update
Makefile
- Create environment
- Run tests
- Readme to .rst (.md to .rst)
- Upload to test Pypi
- Upload Sphinx documentation to test Pypi
- Upload to main Pypi
- Upload Sphinx documentation to main Pypi
- Update
README.md
- Update current stable version
- Update examples
- Update
setup.py
- Update install requires
- Update
dev_environment.yml
&requirements.txt
- Update
__init__.py
version - Update
.travis.yml
(if applicable) - Update
tests
- Update
examples