pyravelry¶

This is python wrapper for the Ravelry API (a database of knitting / crocheting patterns).

Use of this API wrapper requires a Ravelry Account and a username and apikey as specified in the HTTP Basic Auth section of the Ravelry API Documentation.

Quick Start:

$pip install pyravelry
$python -i
>>> from pyravelry import Client, Settings
>>> settings = Settings(RAVELRY_USERNAME=..., RAVELRY_API_KEY=...)
>>> client = Client(settings=settings)
>>> results = client.search.query(query="merino", limit=10, types="Yarn")
>>> results[0].title
'MerinoSeide'

I've checked the API endpoints / models that are currently supported from the official Ravelry Documentation. The crossed ones are not planned to ever be supported:

Endpoints:

Models: