Skip to content

21dimensions/python-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

easyeasy.client

How to use

Install

pip install easyeasy

Initialize

from easyeasy.client import Client

client = Client("bc420813-17d9-47fa-9d29-8bd6a1207f8a")

Examples

class Cat:
    def __init__(self):
        self.id = None
        self.name = None
        self.interests = []
        self.age = None

cat = Cat()
cat.name = "Sam"
cat.age = 1.5
cat.interests = ["play", "eat", "discover"]

# add object. entity name will be inferred from class name
id = client.add(cat)

# or specify entity name explicitly
id = client.add(cat, "cat")

# get one object by id. Specify entity type. Entity name will be inferred
cat = client.get_one(id, Cat)

# or specify entity name explicitly
cat = client.get_one(id, Cat, "cat")
# at least one should be specified(entity_class or entity_name). In case entity_class not specified, dict object will be returned


# update object
cat.age = 2.0
cat.interests = ["eat", "sleep", "play"]

# object must have id property to distinguish which object is being updated. entity_name can be specified explicitly
client.update(cat)

# get all objects. entity_name can be specified explicitly
cats_collection = client.get(Cat)

# filtering
cats_collection = client.get(Cat, query={'age': 1.5})  # get 1.5 years old cats
cats_collection = client.get(Cat, query={'age_gt': 1.0})  # cats older than 1 year
cats_collection = client.get(Cat, query={"name_like": "Sa*"})  # wildcard

# paging
cats_collection = client.get(Cat, query={"_start": "10", "_count": 10})

# ordering
cats_collection = client.get(Cat, query={"_orderby":"age"})
cats_collection = client.get(Cat, query={"_orderbydesc":"age"})

# learn more about filtering operators at: http://easyeasy.io/docs#/operators

# delete object by id
client.delete(cat.id, Cat)

Licence

ISC

Releases

No releases published

Packages

No packages published

Languages