Skip to content
This repository has been archived by the owner on May 9, 2021. It is now read-only.
/ Brickfront Public archive

A library for interfacing with Brickset.com. Only works with the v2 API.

License

Notifications You must be signed in to change notification settings

4Kaylum/Brickfront

Repository files navigation

Intro

Brickfront is a basic interface for working through Brickset's API. It should be pretty simple to use, though I do have the code reference if there's anyhing too difficult.

Installation:

pip install brickfront

Getting Started

There's quite basic usage. For most things you don't need an API key, but for others you may need to get one.

First you need to make a Client object.

>>> import brickfront
>>> client = brickfront.Client(API_KEY)

From there, you can make requests through your client to be able to get different sets.

>>> setList = client.getSets(query='star wars')
>>> len(setList)
20
>>> build = setList[18]
>>> build.name
"Jabba's Palace"
>>> build.setID
'2141'
>>> build.pieces
231
>>> build.priceUK
'27.99'

Most code is fully internally documented, so it will autofill and properly interface with Python's help function.

API Reference

Click here