eazyrest 0.9.0

Building blocks for easy REST API consumption

eazyrest

eazyrest is a small library for consuming REST APIs with less boilerplate. It combines a session-based API client with a lightweight, type-directed JSON object mapping layer that models REST resources as typed Python classes.

Installation

pip install eazyrest

Requires Python 3.10+.

Example

The example uses the public REST demo API available at https://jsonplaceholder.typicode.com/.

from eazyrest import API, JSONObject, json_object

demo_api = API("https://jsonplaceholder.typicode.com/")

class JSONPlaceholderObject(JSONObject):
  """A JSON object from the JSONPlaceholder API"""
  pass

# Set class variable to point to JSONPlaceholder API instance
JSONPlaceholderObject.api = demo_api

@json_object
class User(JSONPlaceholderObject):
  """Represents one user object from JSONPlaceholder API."""
  class_url = "/users/"

  id: int
  name: str
  username: str
  email: str
  address: dict
  phone: str
  website: str
  company: dict

  def __str__(self):
      return self.name

@json_object(field_map={'user': 'userId'})
class Todo(JSONPlaceholderObject):
  """Represents one Todo object from JSONPlaceholder API."""
  class_url = "/todos/"

  id: int
  user: User
  title: str
  completed: bool

# Load one object by primary key (GET /todos/1/)
todo = Todo(id=1)
print(todo.title, todo.completed)

# Demonstrate loading of related object
print(todo.user)

# Query a collection (GET /todos/?userId=1)
todos_for_user_1 = Todo.filter(userId=1)
print(len(todos_for_user_1))

# Access typed fields
first = todos_for_user_1[0]
print(first.id, first.user.id, first.user, first.title)

License

MIT. See LICENSE.

Development

python3 -m venv .venv
. .venv/bin/activate
python -m pip install -U build twine
python -m build
python -m twine check dist/*

Publishing

To publish to PyPI:

python -m twine upload dist/*

To publish to Test PyPI:

python -m twine upload --repository testpypi dist/*