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 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()
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.5.1.tar.gz.
File metadata
- Download URL: compass-interface-core-0.5.1.tar.gz
- Upload date:
- Size: 32.4 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.56.0 CPython/3.8.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fadc67f4214366bea34dd409f8c6d271ebb9e9a691f71bb41558ec953533218f |
|
| MD5 | 84c18544273aa9709d969f0b38fd5831 |
|
| BLAKE2b-256 | 9595c9285406243f016340d709415e1515e086bf38f1861007607766f784eb44 |
File details
Details for the file compass_interface_core-0.5.1-py3-none-any.whl.
File metadata
- Download URL: compass_interface_core-0.5.1-py3-none-any.whl
- Upload date:
- Size: 37.6 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.56.0 CPython/3.8.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5c81c40cc9013828e23cc582ff146d24ed9eea3841284f726ac073f236b4979e |
|
| MD5 | 66709d14a2e4833a7764ec17100cea1d |
|
| BLAKE2b-256 | ee5c849a0443b4d332c4e293a326de44cfc96bfe668d81b6b6d08abb8ed2b0ae |
