Development.md

Development

Design goals

• Minimal dependencies
• Easy to extend or customize

Development dependencies

• twine: Optional. Used to publish package to PyPI

Development installation

# Install
sudo python setup.py develop

# Uninstall
sudo python setup.py develop --uninstall

Publish

Steps

1. Update the version number in pdmreader/__init__.py
2. Update changelog
3. Commit and tag: git tag v0.1
4. Make sure the working directory is clean to avoid unexpected change or files published. Git stash if necessary: git stash save --include-untracked

TestPyPI

It's a good practice to publish to TestPyPI before publishing to PyPI.

Setting up TestPyPI in pypirc

rm -rf dist/*
python setup.py sdist bdist_wheel
twine upload -r testpypi dist/*

PyPI

All published versions cannot be modified. Double check before publishing.

rm -rf dist/*
python setup.py sdist bdist_wheel
twine upload dist/*