Building Open Source libraries

How to build something great that is usable for everyone else. It was presented at the budapest.py Python Meetup.

Transcript

1. Building Open Source libraries @bfaludi @wunderlist @microsoft
2. Bence Faludi → Data & Applied Scientist at Microsoft → Lives in Berlin, Germany → Building data pipelines, data infrastructure → Open source addict → Working on Wunderlist, a multi platform to-do application
3. Wunderlist
5. Disclaimer All opinions shared are my own.
6. Most of the available OS packages are not ready to use
7. Common problems → Lack of documentation or missing examples. → Not installable via pip and easy_install. → Wrong or missing license. → Dependency hell. → Not tested or minimal test coverage. → Not working on every Python version.
8. How to build an Open Source library?
9. Do not implement something that already exists
10. Never create or import a package for basic functionality
11. Do not mix the two previous problems
12. Build something that matters
13. Make it useable → Add a short overview of the package. → Write examples how to use it. → Add a license, probably MIT. → Make unit tests at least 80% coverage. → Use Travis to make it reliable. → Publish into pypi.
14. OS package ⇢ ! ⇢ Production
15. Use the trash → Remove basic function dependencies and write them yourself! → Version and dependency update can be terrifying so use as less dependency as humanly possible. → Remove snippets of code with different license terms.
16. Support all version Python 2.x ⇢ Python 3.x pypy ⇢ pypy3 ...
17. Make it production ready → Do not change the API. → Support legacy and new versions. → Increase the version after every modification. → Use as less dependency as possible and check the code/community activity. → Split huge packages into smaller packages. → Freeze small & not changing sub-packages!
18. Split into smaller packages → Similar to micro services. → Lot of disposable components. → Easier to maintain and reuse. → Testable separately. → Freeze the not changing parts. → Make sure that it's not a basic function!
19. Maintain your library
20. GLHF
21. Thank you for your attention! @bfaludi