Skip to main content

Python library for creating customizable BPPTKG Monitoring API chart

Project description

KomaPy

Python library for creating customizable BPPTKG Monitoring API chart.

Use Cases

KomaPy is suitable for the following applications:

  • Building automated static chart figure
  • Embedding into a web application for generating pre-defined chart configuration
  • Quick data analysis and visualization
  • Data correlation and processing
  • Generating high quality chart for publication
  • Many more

Requirements

KomaPy depends on Python 3.5+ and several packages. You can see them in requirements.txt file.

Installation

Install the latest version from PyPI by typing this command:

pip install -U komapy

Quick Start

Here it is a quick start example:

from komapy import Chart
from komapy.client import set_api_key

set_api_key('YOUR_API_KEY')

chart = Chart({
    'title': 'RB2',
    'theme': 'seaborn',
    'layout': {
        'data': [
            {
                'series': [
                    {
                        'name': 'edm',
                        'query_params': {
                            'benchmark': 'BAB0',
                            'reflector': 'RB2',
                            'start_at': '2019-04-01',
                            'end_at': '2019-08-01',
                            'ci': True
                        },
                        'fields': ['timestamp', 'slope_distance'],
                        'xaxis_date': True
                    }
                ]
            }
        ]
    }
})

chart.render()
chart.save('RB2.png')

Documentation

Full documentation and tutorials are available at docs/ directory. You can build the documentation by running these commands:

cd /path/to/komapy/
pip install -r requirements.txt
sphinx-build -b html docs/ /path/to/build/ 

Contributing

See CONTRIBUTING.md to learn how to contribute to this project.

Support

This project is maintained by Indra Rudianto. If you have any question about this project, you can contact him at indrarudianto.official@gmail.com.

License

By contributing to the project, you agree that your contributions will be licensed under its MIT license. See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for komapy, version 0.4.0
Filename, size File type Python version Upload date Hashes
Filename, size komapy-0.4.0.tar.gz (15.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page