Unofficial library to automate aspects of British/Scottish/Welsh Cycling's club Membership Manager system
Project description
britishcycling-clubs
About
Unofficial, not affiliated or endorsed by British/Scottish/Welsh Cycling.
Library to automate aspects of British Cycling's Club Management Tool, in order to simplify administration for clubs using it. It probably works for Scottish/Welsh Cycling clubs too, but this hasn't been tested.
Priority is to read data in order to create reports/notifications to club administrators.
Prerequisites
- Credentials for a club using the Club Management Tool
Installation
Install from PyPI, e.g:
pip install britishcycling-clubs
Some functions use Playwright to automate a headless Chromium browser. This needs to be installed:
playwright install chromium
If you're installing in e.g. a bare-bones server/CI environment, you'll probably be prompted to install system dependencies, which you can do with:
playwright install-deps chromium
See also https://playwright.dev/python/docs/browsers#install-system-dependencies
Usage
get_private_member_counts(club_id: str, username: str, password: str) -> dict[str, int]
Get numbers of active, pending, expired members from the club manager page.
Specifically, returns the counts from these tabs:
- Active Club Members
- New [i.e. pending] Club Subscriptions
- Expired Club Members
This takes about 10s.
get_public_club_info(club_id: str) -> dict[str, int | str]
Return information from the club's public profile page; doesn't require login.
Specifically, returns these values:
- Club name
- Total club members (note that this isn't always a live value even if the club uses the Club Management Tool to manage members)
Example scripts
You'll need to copy config_dist.ini
, rename to config.ini
and populate it with club
ID and (optionally) credentials.
example_private_member_counts.py
loads club ID and credentials from config.ini
.
It then retrieves and prints the number of active, expired and new/pending club member
counts from the club's Club Manager pages.
example_public_club_info.py
loads club ID from config.ini
. It then retrieves and
prints the club name and 'total member count' from the club's public profile page.
Project details
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
Hashes for britishcycling_clubs-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06ec259e36393016b2c6ed6d994f4aa4f6a572cb40589d78ccae92e59fdf0bd5 |
|
MD5 | e0a90deb9f1c28e1505ecd17e08ed21a |
|
BLAKE2b-256 | b594ff2adc09aa04f71f80242a8580487e93ad175b748d3b15ac0f3593b8d832 |
Hashes for britishcycling_clubs-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c334ce5fa500f11d685a1bdb4b1a9424e0f086f635df53b4bbb4e123cf0186c |
|
MD5 | bb207b3ea3b9299ee68d82fbfcaf368d |
|
BLAKE2b-256 | b4c72d2416cc427285dc201cc1c1ddfe435f49a1247746fc42cd6f8eeddb2af3 |