Skip to main content

Utilities for interacting with climbing board APIs

Project description

BoardLib 🧗‍♀️

Utilities for interacting with climbing board APIs.

Installation 🦺

python3 -m pip install boardlib

Usage ⌨️

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

Databases 💾

To download the climb database for a given board:

boardlib database <board_name> <database_path> --username <board_username>

This command will first download a sqlite database file to the given path. After downloading, the database will then use the sync API to synchronize it with the latest available data. The database will only contain the "shared," public 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 📚

First, use the database command to download the SQLite database file for the board of interest. The database is not required for any version of the Moonboard. Then download your logbook entries for a given board:

boardlib logbook <board_name> --username=<board_username> --output=<output_file_name> --database-path=<database_path>

This outputs a CSV file with the following fields:

["board", "angle", "climb_name", "date", "logged_grade", "displayed_grade", "is_benchmark", "tries", "is_mirror", "sessions_count", "tries_total", "is_repeat", "is_ascent", "comment"]

Supported Boards 🛹

Currently all Aurora Climbing based boards (Kilter, Tension, etc.) and the Moonboard. The Moonboard web API currently appears to be broken for some iterations of the board, including 2016 and 2024.

Images 📸

First, use the database command to download the SQLite database file for the board of interest. Then download the images for a given board:

boardlib images <board_name> <database_file> <output_directory>

This will fetch all of the images for the given board and place them in output_directory.

Supported Boards 🛹

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

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

boardlib-0.15.1-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: boardlib-0.15.1.tar.gz
  • Upload date:
  • Size: 16.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for boardlib-0.15.1.tar.gz
Algorithm Hash digest
SHA256 71affcf85876d51bf6b3f1f02f1ca095457fd52a091e2509ffcb6454babf0773
MD5 3de21e54975149bbf46c1cef87f57a0f
BLAKE2b-256 04175fece40f62a74bc6e1a2bf103daead4458473708d1d1cfffc31d611ed6cf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: boardlib-0.15.1-py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for boardlib-0.15.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9bf29acf530e4d1b0ed79d673b7b4717996d63378aac6160b3682359fca41934
MD5 ca9e9dd36c33da56a93f94ca1670bbfb
BLAKE2b-256 79eafa17ab82ee2b2cb2d4eed8c4b954f3585ee8893deb9f2c24306ba92d1a95

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page