Skip to main content

Python access to Rebrickable API.

Project description

Rebrick

The rebrick library provides a collection of utilities to retrieve various data from Rebrickable.com bricks repository. It can be used either as a simple tool, which reads requested data and converts them into easy-access custom classes or by using the API directly to allow handling the HTTPResponse in whatever way you want.

Please see the examples folder or in-code documentation of classes and functions to learn more about the rebrick library capabilities as well as the original documentation of the Rebrickable API.

See also a similar tool for BrickSet.com called brickse.

Tool Example

import rebrick

# init Rebrick tool
rb = rebrick.Rebrick("your_API_KEY_here", "your_USER_TOKEN_here", silent=True)

# get set info
data = rb.get_set(6608)
print(data)

# if user token is not provided on init you can get it later to access user data
rb.login("your_username_here", "your_password_here")

# get user partlists
data = rb.get_users_partlists()
print(data)

API Example

import rebrick
import json

# init rebrick module for general reading
rebrick.init("your_API_KEY_here")

# get set info
response = rebrick.lego.get_set(6608)
print(json.loads(response.read()))

# init rebrick module including user reading
rebrick.init("your_API_KEY_here", "your_USER_TOKEN_here")

# if you don't know the user token you can use your login credentials
rebrick.init("your_API_KEY_here", "your_username_here", "your_password_here")

# get user partlists
response = rebrick.users.get_partlists()
print(json.loads(response.read()))

Installation

The rebrick library is fully implemented in Python. No additional compiler is necessary. After downloading the source code just run the following command from the rebrick folder:

$ python setup.py install

or simply by using pip

$ pip install rebrick

Disclaimer

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

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

rebrick-0.4.0.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

rebrick-0.4.0-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

Details for the file rebrick-0.4.0.tar.gz.

File metadata

  • Download URL: rebrick-0.4.0.tar.gz
  • Upload date:
  • Size: 15.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for rebrick-0.4.0.tar.gz
Algorithm Hash digest
SHA256 eaf9832f00defdb1254e44ff890c99dd8e7d94054ed3a4c40edff199337be8fd
MD5 d1560604572e7f866ff645aec966f863
BLAKE2b-256 7fd9161252f0c2306d8740e6304c79445a0b7382cb6fa5b6afbaa73211aa5276

See more details on using hashes here.

File details

Details for the file rebrick-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: rebrick-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 16.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for rebrick-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 26b408fe24a4f446f56d1c68e5c459b6437fe9607f273ad497ee8b6eeb63338c
MD5 9ade9b4ff8d2c3ffb9d5cf8adee8e782
BLAKE2b-256 aa7fe390b68ecd0051e0c1e8cca6f6c6e35a76a84fe666cea841eef28b26ee68

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