Skip to content

Latest commit

 

History

4 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

py_opensdbrussels2026

py_opensdbrussels2026 is a tiny example package for the OpenSD 2026 Brussels summer school. It is intentionally small so it can be used to demonstrate how a Git repository is structured and how open source contributions work.

Assignment

As part of this workshop we aim to co-develop a bit on this package our first assignment is to complete the participant list.

  1. Download and install GitHub Desktop.
  2. Clone this repository to your computer: OWI-Lab/OpenSD2026_Brussels_intro_git.
  3. Add your name to the participant list in participants.csv
  4. Commit your changes to the repository.
  5. Push your changes to a new branch.
  6. Open a pull request.

Secondly we try to resolve an open issue, this one; #1

What it does

The package ships with a small CSV file of participants and exposes one public function:

  • attendee_was_present(first_name, family_name) -> bool

It returns True when the provided participant name exists in the packaged CSV file and False otherwise.

Installation

pip install py_opensdbrussels2026

For local development:

pip install -e .[dev]

Usage

from py_opensdbrussels2026 import attendee_was_present

attendee_was_present("Ada", "Lovelace")

Tests

The test suite contains:

  • a normal boolean check for an invalid attendee name
  • a positive check for a known attendee
  • a joke test that reads the packaged CSV, validates countries via pycountry, and confirms that Belgium is the only intentionally invalid country

Run the tests with:

pytest

GitHub Actions

Two workflows are included:

  • CI workflow for running pytest on pushes and pull requests
  • Publish workflow for building and publishing the package to PyPI when a GitHub release is published

To use the publish workflow, configure PyPI trusted publishing for this repository.

About

A small repository mainly to demonstrate the basic concepts of source control

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages