+- Python Forum (https://python-forum.io)
+-- Forum: General (https://python-forum.io/forum-1.html)
+--- Forum: News and Discussions (https://python-forum.io/forum-31.html)
+--- Thread: How do I properly release my code open-source? (/thread-11256.html)
How do I properly release my code open-source? - Brennan - Jun-30-2018
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. :)
RE: How do I properly release my code open-source? - snippsat - Jun-30-2018
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.