The Workshop

This material is designed to help you get started with packaging your code. It is designed to be a hands-on workshop, where you will be guided through the process of setting up a new project, and then packaging it for distribution.

Although the material is designed to be followed in order, you can jump to any section you like. We usually run this event over a day, with a mix of talks and practical sessions. Here is a rough outline of the day:

Time	Content	Slides	Sections
9:00am - 9:30am	Registration and welcome refreshments
9:30am - 10:00am	Introduction - Why is this important? - The Accelerate Programme - What does it mean to publish software?	Introduction
10:00am - 11:00am	Version Control - Overview of Git and GitHub - Developing code - Key files	Version control
11:00am - 11:30am	Break
11:30am - 1:00pm	Poetry - Setting up Codespaces - Overview of the project - Using Poetry - File structure - Licensing - CLI Entry points	Poetry	Setting up Project overview Poetry
1:00pm - 2:00pm	Lunch
2:00pm - 3:00pm	Testing - Testing scientific software - Writing unit tests	Testing	Testing
3:00pm - 3:30pm	Publishing and documenting - Typing and docstrings - Publishing to PyPI	Documentation	Publishing Documentation
3:30pm - 4:00pm	Break
4:00pm - 5:00pm	Automating everything! - Pre-commit hooks - Testing - Publishing - Documentation		Pre-commits Testing Publishing Documentation