Nile API Python Client
This is the Python SDK for interacting with Nile.
Installing
The Nile Python SDK is available on PyPI, and can be installed via:
pip install nile-api
(in a virtual environment as appropriate).
Usage
Usage examples of the SDK can be found in the Nile examples repository, within the directories with -python in their name.
Basic Example:
import os
from nile_api import AuthenticatedClient
from nile_api.api.users import create_user, list_users
from nile_api.models.create_user_request import CreateUserRequest
# Create an authenticated client with a workspace auth token
client = AuthenticatedClient(base_url='https://prod.thenile.dev', token=os.environ.get("NILE_WS_TOKEN"))
# Create a user
user = create_user.sync(
workspace=os.environ.get("NILE_WORKSPACE"),
client=client,
json_body=CreateUserRequest(email="anon@anon.com", password="secret"),
)
# Log created user to console
print(user.email);
# List all users in the workspace
users = list_users.sync(client=client, workspace=os.environ.get("NILE_WORKSPACE"))
for user in users:
print(f"User {user.email!r} exists")
Development
Commands below generally make use of nox (in some sense a Python-based, testing-centric make).
You can install it by following its install instructions for your OS, or e.g. on macOS, by simply running:
brew install nox
Regenerating (updating) the client is done via openapi-python-client.
To do so, run:
nox -s regenerate
You will want to test the results. First, validate that the client generated with the expected structure (packages and modules):
To do so, run:
nox -s tests
Then you’ll want to do a quick smoke test and make sure the client actually works against Nile. Currently we do it by running https://github.com/TheNileDev/examples/tree/main/quickstart-python example. Before running it you’ll want to make sure that running the example will use the local client and not an installed one.
From the local nile-py repository directory run:
export PYTHONPATH=`pwd`:$PYTHONPATH
venv/bin/python -c "import nile_api; print(str(nile_api.__path__))"
cd ../examples/quickstart-python
./venv/bin/python src/all.py
We pin the version of this generator itself in a requirements file. To update the version of the generator that will be used, run:
nox -s update_openapi_requirements
which should regenerate the openapi-generator-requirements.txt file which you should then commit.
Metadata
Release files for nile-api 0.2.8
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 |
|---|---|---|---|---|
| nile_api-0.2.8.tar.gz | 44.7 kB | Without provenance | Details for nile_api-0.2.8.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| nile_api-0.2.8-py3-none-any.whl | Python 3 | none | any | Details for nile_api-0.2.8-py3-none-any.whl |
Total release size: 169.9 kB
Release files / nile_api-0.2.8.tar.gz
| Download URL | nile_api-0.2.8.tar.gz |
|---|---|
| Size | 44.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4971a5d9e7729654621321f66ca2c70ab6e7a811a7eba603bc094f7261809eec
|
|
BLAKE2b-256 checksum How to use checksums |
ab37773e6dd0fbb6b6984a518e415de16807decdb00719083e49ba3f4e37047b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.15
|
Release files / nile_api-0.2.8-py3-none-any.whl
| Download URL | nile_api-0.2.8-py3-none-any.whl |
|---|---|
| Size | 125.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0eda8d45b82c0fa816f9c7f8bf1adb51dcfadf42a98ef7c79b853b2e476aa6e5
|
|
BLAKE2b-256 checksum How to use checksums |
15816209a0a908433e86bdf44670b9e8b305dc90821fa26e4829ef19f26ed3da
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.15
|
Security for nile-api 0.2.8
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.