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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b5d811550e940606f4c3eea04e50856f2d6ddd2c4589a0eba68d4b29321ea5c2 |
|
MD5 | 0ee10e4033c7e32bfc63c378d2a2cdad |
|
BLAKE2b-256 | c9628998b1a5ca244c65e29b0d556f39ef48faa36502ebbc7f42f7d04f097425 |
Hashes for britishcycling_clubs-0.4.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bae35d11c8aa374faab0f4db35388adbc39e077a7585c2542f472b34d80b850a |
|
MD5 | 4739420cd60afc0b119ccf4607597cef |
|
BLAKE2b-256 | f02d1f34a217aa5156a2e080217e8a685aea338f1177161e32f8912739208710 |