Python Packaging Tutorial

Welcome!

This repository contains a hands-on tutorial for creating modern Python packages.

How to Start

1. Click the "Open in GitHub Codespaces" button above.

   • This will launch a cloud environment with all necessary tools (uv, Python, Git) pre-installed.
   • It may take a few minutes to build the environment the first time.

2. Open the Tutorial:

   • Once VS Code loads in your browser, look at the file explorer on the left.
   • Click on tutorial.ipynb to open the interactive notebook.

3. Run the Cells:

   • Follow the instructions in the notebook to build your package step-by-step.

---

What you will learn

• Initialization: Creating a project with uv.
• Structure: Setting up a professional src layout.
• Development: Using editable installs.
• Testing: Writing automated tests with pytest.
• Integration: How these concepts apply to CoLRev plugins.