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:
-
Every path/method combo becomes a Python module with four functions:
sync: Blocking request that returns parsed data (if successful) orNonesync_detailed: Blocking request that always returns aRequest, optionally withparsedset if the request was successful.asyncio: Likesyncbut async instead of blockingasyncio_detailed: Likesync_detailedbut async instead of blocking
-
All path/query params, and bodies become method arguments.
-
If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
-
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
Metadata
Release files for neptune-api 0.26.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| neptune_api-0.26.0.tar.gz | 64.8 kB | Without provenance | Details for neptune_api-0.26.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| neptune_api-0.26.0-py3-none-any.whl | Python 3 | none | any | Details for neptune_api-0.26.0-py3-none-any.whl |
Total release size: 227.1 kB
Release files / neptune_api-0.26.0.tar.gz
| Download URL | neptune_api-0.26.0.tar.gz |
|---|---|
| Size | 64.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1520043541c794670b8e5858a2bcb7582e0d803b06325e43aaab6a89954a911b
|
|
BLAKE2b-256 checksum How to use checksums |
84ff622e43fc62bbbc40a2421963fc1beb0bba1ea816db57f650a028284ab2be
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / neptune_api-0.26.0-py3-none-any.whl
| Download URL | neptune_api-0.26.0-py3-none-any.whl |
|---|---|
| Size | 162.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b9b21514c51ac4c3afa0a203a799db7a1961bbfbb71a8d3759d15fd331e57d23
|
|
BLAKE2b-256 checksum How to use checksums |
126147c1ecb889fd4fe85836a3fdf59791f30d8861373a7cad4fe9e2bce437b5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Security for neptune-api 0.26.0
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.
To learn more about protecting yourself from malicious actors, visit our package security documentation.