Skip to main content

Utilities for interacting with climbing board APIs

Project description

BoardLib 🧗‍♀️

Utilities for interacting with (undocumented) climbing board APIs.

Installation 🦺

python3 -m pip install boardlib

Usage ⌨️

Databases 💾

To download the climb database for a given board:

boardlib database <board_name> <database_path>

This command will first download a sqlite database file to the given path. After downloading, the database will then use the undocumented sync API to synchronize it with the latest available data. The database contains only the publicly available data. User data is not synchronized. If a database already exists as database_path, the command will skip the download step and only perform the synchronization.

NOTE: The Moonboard is not currently supported for the database command. Contributions are welcome.

Supported Boards 🛹

All Aurora Climbing based boards (Kilter, Tension, etc.).

Logbooks 📚

To download your logbook entries for a given board:

boardlib logbook <board_name> --username=<username> --output=<output_file_name>.csv --grade-type="hueco"

This outputs a CSV file with the following fields:

["board", "angle", "name", "date", "grade", "tries", "is_mirror"]

For example, the command

boardlib moon2017 --username="Luke EF" --output="moon2017.csv" --grade-type="hueco"

would output a file named moon2017.csv with the following contents:

board,angle,name,date,grade,tries, is_mirror
moon2017,40,C3PO,2021-07-13,V5,1, False
moon2017,40,LITTLE BLACK SUBMARINE,2021-07-13,V5,2, False
moon2017,40,MOUNTAIN GOAT HARD,2021-07-13,V5,1, False
...

See boardlib --help for a full list of supported board names and feature flags.

Supported Boards 🛹

Currently all Aurora Climbing based boards (Kilter, Tension, etc.) and all variations of the Moonboard should be supported.

Bugs 🐞 and Feature Requests 🗒️

Please create an issue in the issue tracker to report bugs or request additional features. Contributions are welcome and appreciated.

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

boardlib-0.5.2.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

boardlib-0.5.2-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file boardlib-0.5.2.tar.gz.

File metadata

  • Download URL: boardlib-0.5.2.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for boardlib-0.5.2.tar.gz
Algorithm Hash digest
SHA256 ebee9a0fffc79af04f9669d4eccfcae3ea25b1a127c1b192368afca4810501f0
MD5 2f21281d96d926194430165ce84b7f02
BLAKE2b-256 dc0376be542cc4e0f49cc7317e138e589a15842558e57601b9d7ff1ee69f4ef1

See more details on using hashes here.

File details

Details for the file boardlib-0.5.2-py3-none-any.whl.

File metadata

  • Download URL: boardlib-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for boardlib-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1c94295c313be84382604d33b86917731466ad10035b251e8c565efe80de7466
MD5 afe21a03ad32699ead66e2426e8a1868
BLAKE2b-256 bbc9c47de72bb98cb01ab9689a44a6499263c0e54455152f024df8d17c4a8b0e

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