Skip to main content

Python library for Tvarit API

Project description

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

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

tvarit_api-1.1.tar.gz (10.4 kB view hashes)

Uploaded Source

Built Distribution

tvarit_api-1.1-py2.py3-none-any.whl (16.7 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page