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.1.0.tar.gz (25.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

objectrest-2.1.0-py3-none-any.whl (28.0 kB view details)

Uploaded Python 3

File details

Details for the file objectrest-2.1.0.tar.gz.

File metadata

  • Download URL: objectrest-2.1.0.tar.gz
  • Upload date:
  • Size: 25.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for objectrest-2.1.0.tar.gz
Algorithm Hash digest
SHA256 645ba4d80baae6cf3e85e715dc00c553c308cdd68a3101497818e02e010f2bc6
MD5 c74a6c2295c31752b91148754c95895d
BLAKE2b-256 2a877cb69903cc4fdbff22ed767b7cda5c177770e682515ca282ac4a601a630d

See more details on using hashes here.

File details

Details for the file objectrest-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: objectrest-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 28.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for objectrest-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 42c6d0e7c5ddbbf761d3c4519b1a26a837679758845f07c502aea08f3c755b51
MD5 41be7e682527d473843bd3aed57246be
BLAKE2b-256 e9c56992bdbc33f3667f8a2bbde2cd65034a54c96f59463806c00f4f16d6c579

See more details on using hashes here.

Supported by

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