Python library for Tvarit API
Project description
tvarit_api
What is this library for?
Tvarit API library for Python. Support both 2 and 3 Python versions.
Requirements
You need either 2nd or 3rd version of Python and only the requests
library installed.
Quick start
Install the pip package:
pip install -U tvarit_api
And then connect to your Tvarit API endpoint:
from tvarit_api import Tvarit
tvarit_api = Tvarit(auth='abcde....', host='cloud.tvarit.com')
# Search dashboards based on tag
tvarit_api.search.search_dashboards(tag='applications')
# Find a user by email
user = tvarit_api.users.find_user('test@test.com')
# Add user to team 2
tvarit_api.teams.add_team_member(2, user["id"])
# Create or update a dashboard
tvarit_api.dashboard.update_dashboard(dashboard={'dashboard': {...}, 'folderId': 0, 'overwrite': True})
# Delete a dashboard by UID
tvarit_api.dashboard.delete_dashboard(dashboard_uid='abcdefgh')
Status of REST API realization
Work on API implementation still in progress.
API | Status |
---|---|
Admin | + |
Alerting | + |
Annotations | + |
Authentication | +- |
Dashboard | + |
Dashboard Versions | - |
Dashboard Permissions | + |
Data Source | + |
Folder | + |
Folder Permissions | + |
Folder/Dashboard Search | +- |
Organisation | + |
Other | + |
Preferences | + |
Snapshot | + |
Teams | + |
User | + |
Issue tracker
Please report any bugs and enhancement ideas using the tvarit_api
issue tracker:
https://github.com/tvarit-foggy/tvarit_api/issues
Feel free to also ask questions on the tracker.
License
tvarit_api
is licensed under the terms of the MIT License (see the file
LICENSE).
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file tvarit_api-1.3.linux-x86_64.tar.gz
.
File metadata
- Download URL: tvarit_api-1.3.linux-x86_64.tar.gz
- Upload date:
- Size: 29.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b90584e58223205028d7c2925b26e1ae899ed3090a5faf4048e4757848cf9215 |
|
MD5 | 7685242797b9e885c0106325035a7971 |
|
BLAKE2b-256 | b98dc75b295ec93c3b8e9aafdb4a4df6ec70c8cfc532a3081121b1e4ec00b83f |
File details
Details for the file tvarit_api-1.3-py2.py3-none-any.whl
.
File metadata
- Download URL: tvarit_api-1.3-py2.py3-none-any.whl
- Upload date:
- Size: 21.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8185af1f30d10c7089fdef0b6c65a08a9e4419036a17fa5413faa142ff30bb5e |
|
MD5 | d14125e9bfc4fd77f15bb749606931a5 |
|
BLAKE2b-256 | ab7e738e35179adcd7b33ad05bb001ccb585b67e515509d2b03a0b17ca930ee2 |