osm-sdk 0.1.0.dev1

A Python SDK for Online Scout Manager (OSM)

OSM SDK

OSM SDK is a Python SDK for Online Scout Manager (OSM).

The project is provided as a PyPI package that is published on pypi.org, and it can be installed by running:

pip install osm-sdk

Requirements

OSM SDK requires an OAuth Client ID and Oauth Secret.

These can be generated within OSM, by going to Settings → My Account Details → Developer Tools → Create Application.

Client Credentials Grant must be enabled for the application.

Quick Start

from osm_sdk import OSMClient, OSMAttendanceStatus

client = OSMClient(client_id="...", client_secret="...")

section = client.get_section(name="Scouts")
term = section.current_term()

for member in term.list_members():
    contacts = member.list_contacts()
    print(f"Member: {member.full_name} has {len(contacts)} contacts.")

for event in term.list_events():
    attendance = event.list_attendance()
    attending = [a for a in attendance if a.status == OSMAttendanceStatus.YES]
    print(f"Event: {event.name}: {len(attending)} attending (out of {len(attendance)})")

for meeting in term.list_meetings():
    attendance = meeting.list_attendance()
    attending = [a for a in attendance if a.status == OSMAttendanceStatus.YES]
    print(f"Meeting: {meeting.name}: {len(attending)} attending (out of {len(attendance)})")

By default, OSMClient requests the scopes: section:member:read section:event:read section:programme:read section:attendance:read.

Documentation

The public API is documented in PUBLIC_API.md.

Contributions

Contributions are welcome! Read the contributing guide to get started.

License

This project is licensed under the MIT License.