The unofficial API to the TSA Compass membership database
Project description
Compass Interface - Core
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
- requests - for intuitive HTTP requests
- lxml - for parsing HTML documents
- pydantic, email-validator, phonenumbers - for data validation and parsing
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
api = ci.login("username", "password")
# Get all unique members from your hierarchy
member_set = api.hierarchy.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
api = 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
api = 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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file compass-interface-core-0.15.2.tar.gz.
File metadata
- Download URL: compass-interface-core-0.15.2.tar.gz
- Upload date:
- Size: 43.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.2.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b2869648888bd85928ed69dd12f62bf997a349fcd4cc25ce96b5eff439b4d5ea |
|
| MD5 | a6e1c61e0cdf514356c1038875f34baf |
|
| BLAKE2b-256 | a07afda1f8ae1cec2129c638407c33070dfbca26f26ccfde4d2ea8e52af98588 |
File details
Details for the file compass_interface_core-0.15.2-py3-none-any.whl.
File metadata
- Download URL: compass_interface_core-0.15.2-py3-none-any.whl
- Upload date:
- Size: 49.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.2.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cdf47f78aca469fe291fc296fb6252a408034ea57a6628aa24da2f46c4de2c80 |
|
| MD5 | e1d312cea76e7e6aa5e25d9267565c2b |
|
| BLAKE2b-256 | fa8cc691b95e143c4f8d1717c850adecd78dc5dbbd1d8d278a26ea1bcbf9ea85 |
