GithubHelp home page GithubHelp logo

marcodejongh / boardlib Goto Github PK

View Code? Open in Web Editor NEW

This project forked from lemeryfertitta/boardlib

0.0 0.0 0.0 50 KB

Utilities for interacting with climbing board APIs

License: MIT License

Python 100.00%

boardlib's Introduction

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.

boardlib's People

Contributors

lemeryfertitta avatar akirosingh avatar example123 avatar lekanteto avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.