Skip to content

MrNoScript/compass-interface-core

 
 

Repository files navigation

Compass Interface - Core

PyPI - Python Version PyPI - Status PyPI Latest Release Conda Latest Release License Code style: black

The Compass Interface project aims to provide a unified and well-documented API to the Scouts' national membership system, Compass.

Notice

This is not an official API to Compass and as such should be used in a way that doesn't cause a high request load on the Compass system.

Please also remember your personal data handling obligations (under both GDPR and Scouting policies) whilst using this module.

Where to get it

The source code for the project is hosted on GitHub at the-scouts/compass-interface-core

Installers for the latest release are availibe on Conda and at the Python Package Index (PyPI).

# conda
conda install compass-interface-core
# or PyPI
pip install compass-interface-core

Dependencies

License

Compass Interface - Core is naturally open source and is licensed under the MIT license.

Core Module

This sub-project hosts the extraction functionaility of Compass Interface, and is itself a standalone module for querying Compass.

The main project is found at the-scouts/compass-interface.

Example Usage

import compass as ci

# Turn on debug logging for development
ci.logger.enable_debug_logging()

# Login to Compass
compass_session = ci.login(username=..., password=...)

# Setup Compass Helpers
hierarchy = ci.Hierarchy(compass_session)
people = ci.People(compass_session)

# Get all unique members from the in your hierarchy
member_set = hierarchy.get_unique_members()

About

Core bridge/crawler component for Compass-Interface

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%