Skip to main content

A client library for accessing Photos API

Project description

PhotosAPI_Client

A client library for accessing Photos API

Usage

First, create a client:

from photosapi_client import Client

client = Client(base_url="https://api.example.com")

If the endpoints you're going to hit require authentication, use AuthenticatedClient instead:

from photosapi_client import AuthenticatedClient

client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")

Now call your endpoint and use your models:

from photosapi_client.models import MyDataModel
from photosapi_client.api.my_tag import get_my_data_model
from photosapi_client.types import Response

my_data: MyDataModel = get_my_data_model.sync(client=client)
# or if you need more info (e.g. status_code)
response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)

Or do the same thing with an async version:

from photosapi_client.models import MyDataModel
from photosapi_client.api.my_tag import get_my_data_model
from photosapi_client.types import Response

my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)

By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.

client = AuthenticatedClient(
    base_url="https://internal_api.example.com", 
    token="SuperSecretToken",
    verify_ssl="/path/to/certificate_bundle.pem",
)

You can also disable certificate validation altogether, but beware that this is a security risk.

client = AuthenticatedClient(
    base_url="https://internal_api.example.com", 
    token="SuperSecretToken", 
    verify_ssl=False
)

There are more settings on the generated Client class which let you control more runtime behavior, check out the docstring on that class for more info.

Things to know:

  1. Every path/method combo becomes a Python module with four functions:

    1. sync: Blocking request that returns parsed data (if successful) or None
    2. sync_detailed: Blocking request that always returns a Request, optionally with parsed set if the request was successful.
    3. asyncio: Like sync but async instead of blocking
    4. asyncio_detailed: Like sync_detailed but async instead of blocking
  2. All path/query params, and bodies become method arguments.

  3. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)

  4. Any endpoint which did not have a tag will be in photosapi_client.api.default

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

PhotosAPI_Client-0.6.0.tar.gz (17.7 kB view details)

Uploaded Source

Built Distribution

PhotosAPI_Client-0.6.0-py3-none-any.whl (59.0 kB view details)

Uploaded Python 3

File details

Details for the file PhotosAPI_Client-0.6.0.tar.gz.

File metadata

  • Download URL: PhotosAPI_Client-0.6.0.tar.gz
  • Upload date:
  • Size: 17.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.8

File hashes

Hashes for PhotosAPI_Client-0.6.0.tar.gz
Algorithm Hash digest
SHA256 42552ddab437865c958be33c2eec0f8cac5fcfc1d4f6195296ca28f7170c0522
MD5 19ae569b08f683877b75646f96970962
BLAKE2b-256 1779d9326d0fb5362c7b0f2702c55038dc183822ab3f1804f09ff52b4ad0169f

See more details on using hashes here.

File details

Details for the file PhotosAPI_Client-0.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for PhotosAPI_Client-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 650ffccb0d387e00e4a7e778cfee551fb3cd005195fabba44dbfa882cec73c97
MD5 5984b6a760c3f10a94135a2c0d8294bb
BLAKE2b-256 f2c2e911a56abb4f10d19d146be7dc3a7a85443ca3bd6b3d7f87617d5d15e030

See more details on using hashes here.

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