I am planning on opening sourcing a project that I\'ve been working on for a whi

Question

I am planning on opening sourcing a project that I've been working on for a while and that I think would benefit the community. I've already cleaned up the code, added a reasonable license, and wrote a packaging script for it that runs the unit tests, etc (it's Python, so that means setup.py). I wrote a README that describes the project, my motivations for writing the library, and the basics of how to use it.

What else is expected of me? Is hosting it on GitHub enough or is it expected that I maintain the PyPI packages too? What about testing it with other versions of libraries (I just defined the dependencies as the versions that I use)? What are some nice-to-haves that people really appreciate?

Explanation / Answer

Definitely upload to PyPi and keep it updated, it's really easy and doesn't take much effort. I should be able to use pip/easy_install to install the latest stable version.

Adding a README is a great first step, but having great documentation is even better, and for that you should use sphinx (nice tutorial here). Having quality documentation is crucial if you want people to use your project.

Related Questions

Navigate

• Browse (All)
• Browse I
• Subjects

Integrity-first tutoring: explanations and feedback only — we do not complete graded work. Learn more.