Python Forum

Full Version: How do I properly release my code open-source?
You're currently viewing a stripped down version of our content. View the full version with proper formatting.
I have a GitHub, and I already know how to create repositories. However, just uploading my code on GitHub isn't enough. I see many GitHub README.md files guide people through the installation process. This usually includes pip install etc. etc.

If I create a useful .py file that I want other developers to import, how can I guide them through the installation process? This is kind of an odd question, I am happy to elaborate if needed. :)
I have a tutorial here,it rather big because it cover a lot of stuff.

The short version of steps:
A setup.py together with your useful.py module/package(make sure that import are easy for 3-party users).
The setup.py will generate a wheel file in dist\ folder.
Upload wheel file to PyPi twine upload dist/*.
PyPi use name in setup.py eg name="useful", then on PyPi it will be pip install useful for 3-party users.