This is a Python client for APIs written in Flask-Potion (a powerful Flask extension for self-documenting JSON APIs).
The package uses Requests to provide a super-simple interface to Potion APIs that works with all common authentication methods. It generates classes for each of the resources in the API and automatically handles pagination and resolving and serializing references. It also has some basic IPython Notebook support.
from potion_client import Client
from potion_client.auth import HTTPBearerAuth
from potion_client.exceptions import ItemNotFound
client = Client('http://localhost/api', auth=HTTPBearerAuth('79054025255fb1a26e4bc422aef54eb4'))
u123 = client.User(123)
chomp = client.Animal()
chomp.owner = u123
chomp.name = "Chomp"
chomp.species = "hamster"
chomp.save()
pets = client.Animal.instances(where={"owner": u123}, sort={"created_at": True})
print("{} has {} pet(s)".format(u123.first_name, len(pets))
for pet in pets:
if pet is not chomp:
pet.add_friend(chomp)
print("{} is now friends with Chomp".format(pet.name)))
try:
foo = client.User.first(where={"username": "foo"})
except ItemNotFound:
print("User 'foo' does not exist!")
else:
chomp.update(owner=foo)
print("Chomp has been sold to {}".format(foo.name))
chomp.destroy()
print("RIP, Chomp. You lived a happy life.")
To install potion-client
, run:
pip install potion-client
Potion-client was written by João Cardoso and Lars Schöning.