Skip to main content

A Python package to handle REST API requests, JSON parsing, and pydantic object generation.

Project description

ObjectREST

PyPi License

Tests Open Issues Closed Issues Latest Release

Discord Twitter

A Python package to handle REST API requests, JSON parsing, and pydantic object generation.

Installation

From PyPi: python -m pip install objectrest

From GitHub python -m pip install git+https://github.com/nwithan8/objectrest.git

Usage

This package acts as a middle-man between the user and the Requests library.

Users can call to methods directly, or use the RequestHandler class to set universal parameters (i.e. API tokens), universal headers and/or a universal base URL for all requests

Users can retrieve the raw request, the JSON data from a request, or have the JSON data automatically parsed into a Pydantic model.

Example:

from objectrest import RequestHandler

requests = RequestHandler(base_url="http://rootoftheapi", universal_parameters={'api_key': "thisisanapikey"})

my_object = requests.get_object(url="/object", model=MyObjectClass, params={"limit": 10})

Documentation

Documentation available on ReadTheDocs

Project details


Download files

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

Source Distribution

objectrest-2.0.0.tar.gz (24.7 kB view hashes)

Uploaded Source

Built Distribution

objectrest-2.0.0-py3-none-any.whl (27.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page