Python Forum
How do I properly release my code open-source?
Thread Rating:
  • 2 Vote(s) - 3 Average
  • 1
  • 2
  • 3
  • 4
  • 5
How do I properly release my code open-source?
#1
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. :)
Reply
#2
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.
Reply


Possibly Related Threads…
Thread Author Replies Views Last Post
  Call for Speakers for the 2024 Carolina Code Conference is open until April 15th brightball 0 408 Jan-09-2024, 06:57 PM
Last Post: brightball
  Open-source codes and concept ideas. sourceduty 0 749 Aug-11-2023, 02:11 AM
Last Post: sourceduty
  what stand-alone python-aware open-source editors are around? Skaperen 14 1,980 Jun-11-2023, 11:12 PM
Last Post: Skaperen
Video Bionic Blue: Free open-source action platformer game KennedyRichard 0 667 Jan-23-2023, 01:23 PM
Last Post: KennedyRichard
Lightbulb Open-source ML-based line completion IDE plugin Aekalix 0 1,143 Jun-08-2022, 02:28 PM
Last Post: Aekalix
  compiling but not running source code Skaperen 1 1,292 Jun-05-2022, 10:47 PM
Last Post: Gribouillis
  Python 3.9.11 release? raghupcr 3 2,020 Mar-17-2022, 07:17 AM
Last Post: raghupcr
  Looking for open source projects to contribute cavalcantelucas 2 1,917 Sep-30-2021, 05:55 PM
Last Post: buran
  empty lines in source code Skaperen 6 2,939 Jun-02-2021, 07:11 PM
Last Post: Gribouillis
  What are the key changes in dotenv-linter v3.0.0 release? elizabethlvova 0 1,650 Jan-28-2021, 02:35 PM
Last Post: elizabethlvova

Forum Jump:

User Panel Messages

Announcements
Announcement #1 8/1/2020
Announcement #2 8/2/2020
Announcement #3 8/6/2020