Skip to main content

A client library for accessing Neptune API

Project description

neptune-api

A client library for accessing Neptune API

Usage

First, create a client:

from neptune_api import Client

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

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

from neptune_api import AuthenticatedClient

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

Now call your endpoint and use your models:

from neptune_api.models import MyDataModel
from neptune_api.api.my_tag import get_my_data_model
from neptune_api.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 neptune_api.models import MyDataModel
from neptune_api.api.my_tag import get_my_data_model
from neptune_api.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 neptune_api.api.default

Update OpenAPI spec

Run the following command to regenerate the OpenAPI client:

scripts/update.sh https://<deployment>.neptune.ai/api/client/v1/api-docs

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

neptune_api-0.6.1.tar.gz (35.2 kB view details)

Uploaded Source

Built Distribution

neptune_api-0.6.1-py3-none-any.whl (56.0 kB view details)

Uploaded Python 3

File details

Details for the file neptune_api-0.6.1.tar.gz.

File metadata

  • Download URL: neptune_api-0.6.1.tar.gz
  • Upload date:
  • Size: 35.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.7

File hashes

Hashes for neptune_api-0.6.1.tar.gz
Algorithm Hash digest
SHA256 132a9105fb78347752897c65332889cd5ca96d4536d4b67dab6d0a0eb00b2673
MD5 f9360ed0f0442e9c43ffcaa82b5281b1
BLAKE2b-256 98d1d15bd6754c7c794b9e5dfec30e200b6b9298ccfd2eaaf9f3513241bff22d

See more details on using hashes here.

File details

Details for the file neptune_api-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: neptune_api-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 56.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.7

File hashes

Hashes for neptune_api-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b9e31eac9522c48a2b16f21656a3e0662c0193bf91d71935c2314e5f87f6a762
MD5 b5fa95a538628ee5d76342b929bf4a25
BLAKE2b-256 533bdcc0614c77f2c8f81f8e881ffb68469a9f648721d977b8eb53a5e47c2460

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