Skip to main content

tvarit_api CircleCI GitHub license Codecov

PyPI

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).

Release files for tvarit-api 1.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tvarit-api 1.3.1
File Size Uploaded
tvarit_api-1.3.1.linux-x86_64.tar.gz 30.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for tvarit-api 1.3.1
File Interpreter ABI Platform
tvarit_api-1.3.1-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 52.5 kB

Release files / tvarit_api-1.3.1.linux-x86_64.tar.gz

Download URL tvarit_api-1.3.1.linux-x86_64.tar.gz
Size 30.8 kB
Tags Source
SHA-256 checksum
How to use checksums
b91fe432c36054df936d1eea255ec50c81e2608bb470b30112e14ae72d565f4e
BLAKE2b-256 checksum
How to use checksums
f832535d43c54a7481d0958f968a251402dbcff2291d41e887a22eb31fbb9d4f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.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

Release files / tvarit_api-1.3.1-py2.py3-none-any.whl

Download URL tvarit_api-1.3.1-py2.py3-none-any.whl
Size 21.7 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
3ddceab970a3f9dd63b00f2f7dda6e60476f8f8a14f95ec34567609f719173ee
BLAKE2b-256 checksum
How to use checksums
76e536517afb28fa26ef6d24fa8a86ecd8da77dd612baa2b34033c7caad9148b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.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

Release history Release notifications | RSS feed

This release

1.3.1 This release

2 release files

1.3

2 release files

1.2

2 release files

1.1

2 release files

1.0.1

1 release file

1.0.0

1 release file

0.7.5

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page