Skip to content

Latest commit

 

History

History
55 lines (30 loc) · 2.21 KB

README.md

File metadata and controls

55 lines (30 loc) · 2.21 KB

Actions Status Coverage Status

pyrebrickable

This is pyrebrickable, a package for interacting with rebrickable (www.rebrickable.com=)

Documentation can be found in the accompanying Pages here

rebrickable.api

The rebrickable.api hierarchy was automatically generated by OpenAPI generator project,

CLI

This Python package provides a CLI wrapper around the Rebrickable API

It supports the v3 API through it's openAPI specification.
https://rebrickable.com/api/v3/swagger/?format=openapi
Models for Part, Set, etc. have been manually added to provide meaningful results from HTTP responses

Some endpoints might not work, don't hesitate to file an issue

Once the pyrebrickable package is installed through pip install pyrebrickable you should have access to a rebrickable command.

rebrickable.data

This package makes use of the monthly CSV database dumps, import them into a local database and provide you a way through SQLAlchemy to query that database

You can access it through its CLI at rebrickable-data

Requirements.

Python 2.7 and 3.5+

Installation & Usage

pip install pyrebrickable

Getting Started

For the CLI: with the package installed, run

rebrickable --help

You can also read the CLI docs, auto-generated documentation from the Click definitions in cli.py

To use the API, use from rebrickable_api import [...], see the API docs for how to use it

To use the rebrickable_data package, see Data docs and some examples in the repo

Author

Matthieu Berthomé @rienafairefr

[]: https://travis-ci.org/rienafairefr/pyrebrickable