Packaging and publishing python software for research

Welcome to the material on packaging and publishing python software.

There are three branches to this repo:

• main contains the slides and starting code, plus some details about how to work through the material.
• basic contains the basic starting code, and nothing else.
• result contains the final product, that you should hopefully put together yourself.

At the bottom of each section, you will find some further resources on the concepts discussed within.

Sections

• Setting up

  ---

  Setting up your GitHub repo and Codespace

• Project overview

  ---

  An overview of the project - moving from Jupyter Notebooks to python scripts

• Package Management with uv

  ---

  An introduction to the power of uv

• Testing

  ---

  How to test your package

• Publishing

  ---

  Publishing to PyPI and making documentation with MkDocs

• CI/CD

  ---

  How to automate the everything!

• Slides

  ---

  Here you can find the slides for the course material

• Resources

  ---

  Each section contains a summary of further resources, but here they are all collected for convenience