Uploaded December 2024 | Updated September 2026, 3 hours ago
(Tennessee Leeuwenburg) Making an open source package is pretty hard in 2024. Expectations are high, and there’s a lot to take into account. I recently developed an open source package. This talk covers what worked, what didn’t work, what I would do again and what I would do differently.
I developed an open source package called “scores” ( github.com/nci/scores , scores.readthedocs.io ). This is not a presentation about what “scores” does, but instead covers the lessons I learned. Despite being an experienced software developer and having used lots of open source software, there was still a lot to learn (and a lot to figure out) about open source package maintenance.
Every package is different, but this is what I did and these are the lessons I learned.
- Technical Matters:
- How to lay things out on disk
- Configuration files
- Automated testing
- Type hinting
- Linting and other static analysis tools
- Code layout and design
- Documentation:
- What documentation to produce
- Picking and using a tech stack
- Rendering (documentation often renders differently in different locations)
- Ecosystem Integration:
- How to fit in well with the tools around you
- Versioning
- Publishing to PyPI
- How and what to automate
- How to do releases
- Community Considerations:
- Code review standards
- Clear presentation of information
- Understanding your user base and audience
pretalx.com/pycon-au-2024/talk/MW7E7N
python, pycon, australia, programming, conference, technical, developers, panel, sessions, libraries, frameworks, community, sysadmins, students, education, data, science
Videos licensed as CC-BY-NC-SA 4.0
PyCon AU is the national conference for the Python programming community, bringing together professional, student and enthusiast developers, sysadmins and operations folk, students, educators, scientists, statisticians, and many others besides, all with a love for working with Python.
Licensed as CC BY-NC-SA - creativecommons.org/licenses/by-nc-sa/4.0
Produced by Next Day Video Australia: https://nextdayvideo.com.au
Sat Nov 23 10:40:00 2024 at Door 12 / Goldfields Theatre
(Tennessee Leeuwenburg) Making an open source package is pretty hard in 2024. Expectations are high, and there’s a lot to take into account. I recently developed an open source package. This talk covers what worked, what didn’t work, what I would do again and what I would do differently.
I developed an open source package called “scores” ( github.com/nci/scores , scores.readthedocs.io ). This is not a presentation about what “scores” does, but instead covers the lessons I learned. Despite being an experienced software developer and having used lots of open source software, there was still a lot to learn (and a lot to figure out) about open source package maintenance.
Every package is different, but this is what I did and these are the lessons I learned.
- Technical Matters:
- How to lay things out on disk
- Configuration files
- Automated testing
- Type hinting
- Linting and other static analysis tools
- Code layout and design
- Documentation:
- What documentation to produce
- Picking and using a tech stack
- Rendering (documentation often renders differently in different locations)
- Ecosystem Integration:
- How to fit in well with the tools around you
- Versioning
- Publishing to PyPI
- How and what to automate
- How to do releases
- Community Considerations:
- Code review standards
- Clear presentation of information
- Understanding your user base and audience
pretalx.com/pycon-au-2024/talk/MW7E7N
python, pycon, australia, programming, conference, technical, developers, panel, sessions, libraries, frameworks, community, sysadmins, students, education, data, science
Videos licensed as CC-BY-NC-SA 4.0
PyCon AU is the national conference for the Python programming community, bringing together professional, student and enthusiast developers, sysadmins and operations folk, students, educators, scientists, statisticians, and many others besides, all with a love for working with Python.
Licensed as CC BY-NC-SA - creativecommons.org/licenses/by-nc-sa/4.0
Produced by Next Day Video Australia: https://nextdayvideo.com.au
Sat Nov 23 10:40:00 2024 at Door 12 / Goldfields Theatre
