Skip to main content
Latest Version Latest version Documentation Status https://img.shields.io/badge/license-Apache%202.0-blue.svg

cdumay-rest-client

This library is a basic REST client with exception formatting.

Quickstart

First, install cdumay-rest-client using pip:

$ pip install cdumay-rest-client

Next, add a RESTClient instance to your code:

import json, sys
from cdumay_rest_client.client import RESTClient

client = RESTClient(server="http://jsonplaceholder.typicode.com")
json.dump(
    client.do_request(method="GET", path="/posts/1"),
    sys.stdout,
    sort_keys=True,
    indent=4,
    separators=(',', ': ')
)

Result:

{
    "body": "quia et suscipit\nsuscipit recusandae [...]",
    "id": 1,
    "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
    "userId": 1
}

Exception

You can use marshmallow to serialize exceptions:

import json, sys
from cdumay_rest_client.client import RESTClient
from cdumay_http_client.exceptions import HTTPException, HTTPExceptionValidator

try:
    client = RESTClient(server="http://jsonplaceholder.typicode.com")
    data = client.do_request(method="GET", path="/me")
except HTTPException as exc:
    data = HTTPExceptionValidator().dump(exc).data

json.dump(data, sys.stdout, sort_keys=True, indent=4, separators=(',', ': '))

Result:

{
    "code": 404,
    "extra": {},
    "message": "Not Found"
}

License

Licensed under Apache License 2.0 or https://opensource.org/licenses/Apache-2.0.

Metadata

Release files for cdumay-rest-client 0.2.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cdumay-rest-client 0.2.6
File Size Uploaded Provenance
cdumay-rest-client-0.2.6.tar.gz 7.2 kB Without provenance Details

Release files / cdumay-rest-client-0.2.6.tar.gz

Download URL cdumay-rest-client-0.2.6.tar.gz
Size 7.2 kB
Tags Source
SHA-256 checksum
How to use checksums
b35ac66ffcf7dddd1489a63387516c47fd02ad111ed30e8ed329828b48979182
BLAKE2b-256 checksum
How to use checksums
db350d3bc76a89a138486c27b72b97ecf1069abc370b4aac26dbe93d12e8830f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.8.7

Security for cdumay-rest-client 0.2.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.2.6 This release

1 release file No provenance

0.0.1

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page