Skip to main content

The unofficial API to the TSA Compass membership database

Project description

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.core 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 your hierarchy
member_set = hierarchy.get_unique_members()

Specifying a role

By default, Compass Interface uses your primary role to access Compass. To change this, a custom role can be specified when calling ci.login, as follows:

import compass.core as ci

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

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

The string passed to the role argument must match the role title on Compass exactly, as they are compared internally. You can validate that the role has updated successfully through the log output.

Specifying a role and location

If you have multiple roles with the same title on compass (for example, two Group Administrator or Scout Active Support Manager roles), these can be differentiated by also specifying a role location, as follows:

import compass.core as ci

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

# Login to Compass
compass_session = ci.login("username", "password", role="role_as_on_compass", location="location_as_on_compass")

As with the role title, the location needs to match the text in the Location column of My Roles exactly, as we verify the text matches internally.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

compass-interface-core-0.9.2.tar.gz (37.2 kB view details)

Uploaded Source

Built Distribution

compass_interface_core-0.9.2-py3-none-any.whl (40.8 kB view details)

Uploaded Python 3

File details

Details for the file compass-interface-core-0.9.2.tar.gz.

File metadata

  • Download URL: compass-interface-core-0.9.2.tar.gz
  • Upload date:
  • Size: 37.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.8

File hashes

Hashes for compass-interface-core-0.9.2.tar.gz
Algorithm Hash digest
SHA256 3b7ef099f12b82936f48af1bbb864fa3564d95ce01ec8071c625f03f76f070fd
MD5 ad2d588be6aa8172da932e14dbf954bc
BLAKE2b-256 aed7b363f4b513b62639c312f156aa342bb321bf47f3a5360ad00fc257376c08

See more details on using hashes here.

File details

Details for the file compass_interface_core-0.9.2-py3-none-any.whl.

File metadata

  • Download URL: compass_interface_core-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 40.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.8

File hashes

Hashes for compass_interface_core-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ba8d4f1ba02dbe62490d09830d7303f57b248dba2e9adec5545e1410688ada3d
MD5 620fec367dfb67cf857e81a4fb1474b1
BLAKE2b-256 77ccd9b2c29ddd372041ce51a2da2872687c303348ee6e359183834859b5f038

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page