| Name | fern-vitruvi JSON |
| Version |
0.0.6
JSON |
| download |
| home_page | |
| Summary | |
| upload_time | 2023-06-06 20:46:18 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7,<4.0 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Vitruvi Python Library
[](https://pypi.python.org/pypi/fern-vitruvi)
[](https://github.com/fern-api/fern)
## Installation
Add this dependency to your project's build file:
```bash
pip install fern-vitruvi
# or
poetry add fern-vitruvi
```
## Authorization
You can use either a JWT or a Bearer token to authenticate with Vitruvi.
```python
from vitruvi.client import Vitruvi
vitruvi_client = Vitruvi(api_key="Bearer YOUR_TOKEN")
vitruvi_client = Vitruvi(api_key="JWT YOUR_JWT")
```
## Usage
```python
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:
```python
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!
Raw data
{
"_id": null,
"home_page": "",
"name": "fern-vitruvi",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/2f/9f/0d99a4993b06f4dd4577572c50849ecd09ff5b253a8e4942d7e9be89b648/fern_vitruvi-0.0.6.tar.gz",
"platform": null,
"description": "# Vitruvi Python Library\n\n[](https://pypi.python.org/pypi/fern-vitruvi)\n[](https://github.com/fern-api/fern)\n\n## Installation\n\nAdd this dependency to your project's build file:\n\n```bash\npip install fern-vitruvi\n# or\npoetry add fern-vitruvi\n```\n\n## Authorization\n\nYou can use either a JWT or a Bearer token to authenticate with Vitruvi. \n\n```python\nfrom vitruvi.client import Vitruvi\n\nvitruvi_client = Vitruvi(api_key=\"Bearer YOUR_TOKEN\")\n\nvitruvi_client = Vitruvi(api_key=\"JWT YOUR_JWT\")\n```\n\n## Usage\n\n```python\nfrom vitruvi.client import Vitruvi\n\nvitruvi_client = Vitruvi(api_key=\"Bearer YOUR_TOKEN\")\n\npermission = vitruvi_client.create_auth_permissions(Vitruvi.Permission(\n id=\"permission-id\",\n name=\"permission-name\",\n codename=\"codename\")\n))\n\nprint(permission)\n```\n\n## Async client\n\nThis SDK also includes an async client, which supports the `await` syntax:\n\n```python\nimport asyncio\nfrom vitruvi.client import AsyncVitruvi\n\nvitruvi_client = AsyncVitruvi(api_key=\"Bearer YOUR_TOKEN\")\n\nasync def create_permission() -> None:\n permission = vitruvi_client.create_auth_permissions(Vitruvi.Permission(\n id=\"permission-id\",\n name=\"permission-name\",\n codename=\"codename\")\n ))\n print(permission)\n\nasyncio.run(create_permission())\n```\n\n## Beta status\n\nThis 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.\n\n## Contributing\n\nWhile 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!\n\nOn the other hand, contributions to the README are always very welcome!\n",
"bugtrack_url": null,
"license": "",
"summary": "",
"version": "0.0.6",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "89d148b702d748a80c254ecaa12ab18d49d2abaf6859599d60b102f9ec5e2945",
"md5": "a12424bb5163a35d7616438753bfc2fb",
"sha256": "35700fcf09e16b30978947e10688aed66f882a00c19110f2569a2eaa6e5b3451"
},
"downloads": -1,
"filename": "fern_vitruvi-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a12424bb5163a35d7616438753bfc2fb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 52188,
"upload_time": "2023-06-06T20:46:16",
"upload_time_iso_8601": "2023-06-06T20:46:16.340714Z",
"url": "https://files.pythonhosted.org/packages/89/d1/48b702d748a80c254ecaa12ab18d49d2abaf6859599d60b102f9ec5e2945/fern_vitruvi-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2f9f0d99a4993b06f4dd4577572c50849ecd09ff5b253a8e4942d7e9be89b648",
"md5": "8b91c8d73f536b70032787bad537a30c",
"sha256": "c6c1ba7ce0c5f46e186c877d8dbf5bf295e311b5cf55d5687628c9b83b89d29c"
},
"downloads": -1,
"filename": "fern_vitruvi-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "8b91c8d73f536b70032787bad537a30c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 18567,
"upload_time": "2023-06-06T20:46:18",
"upload_time_iso_8601": "2023-06-06T20:46:18.154401Z",
"url": "https://files.pythonhosted.org/packages/2f/9f/0d99a4993b06f4dd4577572c50849ecd09ff5b253a8e4942d7e9be89b648/fern_vitruvi-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-06 20:46:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "fern-vitruvi"
}
