Metadata-Version: 2.0
Name: brickfront
Version: 0.0.5
Summary: A wrapper for Brickset written in Python.
Home-page: https://github.com/4Kaylum/Brickfront
Author: Callum Bartlett
Author-email: callum.b@techie.com
License: mit
Download-URL: https://github.com/4Kaylum/Brickfront/tarball/0.0.5
Keywords: lego web brickset
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Internet
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Requires-Dist: requests

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**:

.. code-block:: bash

	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`__.

__ http://brickset.com/tools/webservices/requestkey

First you need to make a `Client` object.

.. code-block:: python

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

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

.. code-block:: python

	>>> 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`__

__ https://brickfront.readthedocs.io/en/latest/index.html

