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 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()

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.4.3.tar.gz (30.1 kB view details)

Uploaded Source

Built Distribution

compass_interface_core-0.4.3-py3-none-any.whl (33.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: compass-interface-core-0.4.3.tar.gz
  • Upload date:
  • Size: 30.1 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

Hashes for compass-interface-core-0.4.3.tar.gz
Algorithm Hash digest
SHA256 cd2cda9777b7641065d8f7e1947aa31437ff826a3807bc3e5a247c39e141657c
MD5 6a5a825b2a0450690cdb6ae70137c51d
BLAKE2b-256 838ba1b2d683485af500c2c61df515752fe0149a6c4878a1f607ae14460d13b9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: compass_interface_core-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 33.9 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

Hashes for compass_interface_core-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e5256d3a5ed6e535119371563970c5507ecc904ce8a0bb179c7b446a728577eb
MD5 7d70eb9aa480c2c1185c4e9a72a09522
BLAKE2b-256 d69c33f73823a58b0cd82c5c469f19e9570ae01e9a34a725658e7b96681ff32b

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