https://github.com/kairosdb/kairosdb-examples-python

Code examples on how to use KairosDB REST API through Python and requests module.
https://github.com/kairosdb/kairosdb-examples-python

Last synced: about 1 month ago
JSON representation

Code examples on how to use KairosDB REST API through Python and requests module.

• Host: GitHub
• URL: https://github.com/kairosdb/kairosdb-examples-python
• Owner: kairosdb
• Created: 2016-01-21T13:44:18.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-01-21T13:49:52.000Z (almost 9 years ago)
• Last Synced: 2024-04-16T07:33:43.253Z (9 months ago)
• Language: Python
• Size: 3.91 KB
• Stars: 11
• Watchers: 6
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# kairosdb-examples-python

Some code examples on how to use [KairosDB](http://kairosdb.org/) REST API through Python and requests module. Currently we've the following code examples:

**Data points**:

- [Insert (with or without compression)](data_points/insert.py)

- [Query](data_points/query.py)

- [Delete](data_points/delete.py)

**Metrics**:

- [List](metrics/list.py)

- [Delete](metrics/delete.py)

**Tags**:

- [List Tag Names](tags/list_tag_names.py)

- [List Tag Values](tags/list_tag_values.py)

**Misc**:

- [Health status](misc/health.py)

- [Version](misc/version.py)

For complete details about the KairosDB REST API, please [check their documentation](http://kairosdb.github.io/docs/build/html/restapi/index.html).

## How to run the examples? 

In order to run the examples you should have a KairosDB server locally (check if it is running going to [http://localhost:8080/](http://localhost:8080/) - if KairosDB Web UI appears, than everything is fine). After that, you can open your Terminal e just run `python3 .py` in the desired example.

For example, if you want to list all metrics just run `python3 metrics/list.py`. 

## Roadmap

- Add some scripts to download a test version of KairosDB, run the server locally and import a test database. With that it's possible to really test the code examples without the need of setting up an environment.

- Add complex code examples ([do you have a suggestion for this topic?](https://github.com/paladini/kairosdb-examples-python/issues/new))

## Suggestions? Problems? Critics? 

If you have suggestions, problems with the code, critics or anything like that don't hesitate in creating a [new GitHub Issue](https://github.com/paladini/kairosdb-examples-python/issues/new) or making a Pull Request. 

Actually I want to improve the repository, but I don't have ideas on what to do.

## About

I've created this repository because I'm the only guy at my laboratory that actually learned about KairosDB and (sometimes) my coworkers need to do something envolving KairosDB and they don't know how to do that. These code examples will be useful for them.