Quickstart¶

Install the beta library with Python 3.12 or newer:

uv add rebrickable
rebrickable status
rebrickable refresh

The refresh downloads and validates all 12 daily gzip CSV files. It builds a unique snapshot and changes one atomic active pointer only after schema, cross-file references, FTS, row counts, and SQLite integrity pass. A transient mixed CDN generation is downloaded once more after a bounded delay; a second failure leaves the old snapshot active.

from rebrickable import RebrickableSession, SearchKind

async with await RebrickableSession.open() as session:
    result = await session.search("3001 brick", kinds={SearchKind.PART})
    part = await session.parts.require(result.hits[0].canonical_id)
    inventory = await session.sets.inventory("10497-1")

Live API calls are deliberately separate and always receive an explicit key:

from rebrickable import RebrickableClient

async with RebrickableClient(api_key=api_key) as client:
    part = await client.get_part("3001")
    async for lego_set in client.iter_sets(search="Galaxy Explorer"):
        print(lego_set.set_num, lego_set.name)

Config.load() reads YAML and then overlays REBRICKABLE_API_KEY. Normal Config.write() calls omit the key. Persisting it requires include_secrets=True, atomically rewrites the complete file, and applies mode 0600 where supported. User tokens and passwords are never persisted.