API Reference

from nvisy import Client

client = Client(config)

Client(config)                # From a dict or ClientConfiguration
Client.from_environment()     # From NVISY_* environment variables
Client.builder()              # Returns a ClientBuilder

await client.get(path, **kwargs)
await client.post(path, **kwargs)
await client.put(path, **kwargs)
await client.patch(path, **kwargs)
await client.delete(path, **kwargs)

client.get_sync(path, **kwargs)
client.post_sync(path, **kwargs)
client.put_sync(path, **kwargs)
client.patch_sync(path, **kwargs)
client.delete_sync(path, **kwargs)

await client.close()   # async
client.close_sync()    # sync

Client.builder() \
    .with_api_key("your-api-token") \
    .with_base_url("https://api.nvisy.com") \
    .with_timeout(60.0) \
    .with_max_retries(5) \
    .with_user_agent("MyApp/1.0.0") \
    .with_header("X-Custom", "value") \
    .with_headers({"X-A": "1", "X-B": "2"}) \
    .with_debug(True) \
    .build()

from nvisy import ApiError, ClientError, ConfigError, NetworkError

from nvisy import ApiError, NetworkError

try:
    response = client.get_sync("/workspaces/")
except ApiError as error:
    print(error.status_code, error, error.request_id)
except NetworkError as error:
    print("network failure:", error)