wenyang

A Python package example

steps:

1. Give your package a unique name {package.name} in PyPI. You can check with pip search.
2. Create a new repository {package.name} on github as https://github.com/{github.username}/{package.name}
3. git clone https://github.com/{github.username}/{package.name} then you will get folder {package.name} as the {root}
4. Change directory into {root}
5. Create README.md for the package if you did not init your repository with a README.md
6. Read https://packaging.python.org/tutorials/packaging-projects/
7. Create empty package as {package.name}
8. Create setup.py
9. Generate distribution packages
10. python3 -m pip install --upgrade setuptools wheel
11. python3 setup.py sdist bdist_wheel
12. Upload the distribution archives
13. python3 -m pip install --upgrade twine
14. python3 -m twine upload --skip-existing dist/*
15. Check the package on https://pypi.org/project/{package.name}/

references:

1. https://github.com/pypa/sampleproject
2. Github-flavored Markdown