Skip to main content

Encoder for the Siren hypermedia format

Project description

Pypi Travis

Persefone is an encoder for the Siren hypermedia format that uses ujson to generate Siren-compliant JSON efficiently.

Usually such encoders work with JSON, so you convert your data to JSON and pass it to the encoder.

The idea behind persefone is to provide a perfomant Siren encoder by removing the JSON conversion step: you pass your data as provided by your ORM and persefone deals with that, returning JSON.

Supported orms and data structures

Persefone currently supports only peewee, but I plan to add support for other ORMs and similar tools.res

Usage

Install with pip:

pip install persefone

Then:

from persefone.peewee import Siren

Siren(data, '/path', model=MyModel).encode() # returns Siren-valid JSON

If you have a list:

Siren([item, ...], '/path', model=MyModel)

Pagination:

Siren([item, ...], '/path', model=MyModel, total_items=100, current_page=2)

Contributing

Contributions and feedbacks are welcome. You can just open an issue.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
persefone-0.2.0-py3-none-any.whl (5.0 kB) Copy SHA256 hash SHA256 Wheel 3.6 Nov 18, 2017
persefone-0.2.0.tar.gz (2.8 kB) Copy SHA256 hash SHA256 Source None Nov 18, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page