# neptune-api
A client library for accessing Neptune API
## Usage
First, create a client:
```python
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:
```python
from neptune_api import AuthenticatedClient
client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
```
Now call your endpoint and use your models:
```python
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:
```python
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.
```python
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**.
```python
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`
1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
1. `asyncio`: Like `sync` but async instead of blocking
1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking
1. All path/query params, and bodies become method arguments.
1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
1. 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:
```bash
scripts/update.sh https://<deployment>.neptune.ai/api/client/v1/api-docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/neptune-ai/neptune-api",
"name": "neptune-api",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "MLOps, ML Experiment Tracking, ML Model Registry, ML Model Store, ML Metadata Store",
"author": "neptune.ai",
"author_email": "contact@neptune.ai",
"download_url": "https://files.pythonhosted.org/packages/77/2e/91063d2e4bf689568d0075186dfd7e6f1bf5b39ca18a9bb246aeeaf95539/neptune_api-0.1.0.tar.gz",
"platform": null,
"description": "# neptune-api\nA client library for accessing Neptune API\n\n## Usage\nFirst, create a client:\n\n```python\nfrom neptune_api import Client\n\nclient = Client(base_url=\"https://api.example.com\")\n```\n\nIf the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:\n\n```python\nfrom neptune_api import AuthenticatedClient\n\nclient = AuthenticatedClient(base_url=\"https://api.example.com\", token=\"SuperSecretToken\")\n```\n\nNow call your endpoint and use your models:\n\n```python\nfrom neptune_api.models import MyDataModel\nfrom neptune_api.api.my_tag import get_my_data_model\nfrom neptune_api.types import Response\n\nmy_data: MyDataModel = get_my_data_model.sync(client=client)\n# or if you need more info (e.g. status_code)\nresponse: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)\n```\n\nOr do the same thing with an async version:\n\n```python\nfrom neptune_api.models import MyDataModel\nfrom neptune_api.api.my_tag import get_my_data_model\nfrom neptune_api.types import Response\n\nmy_data: MyDataModel = await get_my_data_model.asyncio(client=client)\nresponse: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)\n```\n\nBy 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.\n\n```python\nclient = AuthenticatedClient(\n base_url=\"https://internal_api.example.com\",\n token=\"SuperSecretToken\",\n verify_ssl=\"/path/to/certificate_bundle.pem\",\n)\n```\n\nYou can also disable certificate validation altogether, but beware that **this is a security risk**.\n\n```python\nclient = AuthenticatedClient(\n base_url=\"https://internal_api.example.com\",\n token=\"SuperSecretToken\",\n verify_ssl=False\n)\n```\n\nThere 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.\n\nThings to know:\n1. Every path/method combo becomes a Python module with four functions:\n 1. `sync`: Blocking request that returns parsed data (if successful) or `None`\n 1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.\n 1. `asyncio`: Like `sync` but async instead of blocking\n 1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking\n\n1. All path/query params, and bodies become method arguments.\n1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)\n1. Any endpoint which did not have a tag will be in `neptune_api.api.default`\n\n## Update OpenAPI spec\n\nRun the following command to regenerate the OpenAPI client:\n```bash\nscripts/update.sh https://<deployment>.neptune.ai/api/client/v1/api-docs\n```\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A client library for accessing Neptune API",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://docs.neptune.ai/",
"Homepage": "https://github.com/neptune-ai/neptune-api",
"Repository": "https://github.com/neptune-ai/neptune-api",
"Tracker": "https://github.com/neptune-ai/neptune-api/issues"
},
"split_keywords": [
"mlops",
" ml experiment tracking",
" ml model registry",
" ml model store",
" ml metadata store"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c34465c3ee15c39945d96d7b7fd66a7236aaca6d3916515521587f4f0630f086",
"md5": "cb16c9d5e5d018d1f6bba7fe761c8a7c",
"sha256": "77bc7cba7a7350098dbd5ce72a7469851b803b37ed2fc064d5a0e31e2826606a"
},
"downloads": -1,
"filename": "neptune_api-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb16c9d5e5d018d1f6bba7fe761c8a7c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 24017,
"upload_time": "2024-06-19T14:22:34",
"upload_time_iso_8601": "2024-06-19T14:22:34.555827Z",
"url": "https://files.pythonhosted.org/packages/c3/44/65c3ee15c39945d96d7b7fd66a7236aaca6d3916515521587f4f0630f086/neptune_api-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "772e91063d2e4bf689568d0075186dfd7e6f1bf5b39ca18a9bb246aeeaf95539",
"md5": "2c0e97dd6c2f3d791821afe4ee4bcafb",
"sha256": "d3cf70b7ee70ebf54fbe4033065ce31fc548b5ee957eb51f27c8b1ff1dfa68c4"
},
"downloads": -1,
"filename": "neptune_api-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "2c0e97dd6c2f3d791821afe4ee4bcafb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 14912,
"upload_time": "2024-06-19T14:22:40",
"upload_time_iso_8601": "2024-06-19T14:22:40.773035Z",
"url": "https://files.pythonhosted.org/packages/77/2e/91063d2e4bf689568d0075186dfd7e6f1bf5b39ca18a9bb246aeeaf95539/neptune_api-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-19 14:22:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "neptune-ai",
"github_project": "neptune-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "neptune-api"
}
JSON
