Vitruvi Python Library

Installation

Add this dependency to your project's build file:

pip install vitruvi-sdk
# or
poetry add vitruvi-sdk

Authorization

You can use either a JWT or a Bearer token to authenticate with Vitruvi.

from vitruvi.client import Vitruvi

vitruvi_client = Vitruvi(api_key="Bearer YOUR_TOKEN")

vitruvi_client = Vitruvi(api_key="JWT YOUR_JWT")

Usage

from vitruvi.client import Vitruvi

vitruvi_client = Vitruvi(api_key="Bearer YOUR_TOKEN")

permission = vitruvi_client.create_auth_permissions(Vitruvi.Permission(
  id="permission-id",
  name="permission-name",
  codename="codename")
))

print(permission)

Async client

This SDK also includes an async client, which supports the await syntax:

import asyncio
from vitruvi.client import AsyncVitruvi

vitruvi_client = AsyncVitruvi(api_key="Bearer YOUR_TOKEN")

async def create_permission() -> None:
    permission = vitruvi_client.create_auth_permissions(Vitruvi.Permission(
      id="permission-id",
      name="permission-name",
      codename="codename")
    ))
    print(permission)

asyncio.run(create_permission())

Beta status

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your pyproject.toml file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!