Skip to main content

No project description provided

Project description

Flask-ChartJS

Flask-ChartJS provides a simple interface to use ChartJS javascript library with Flask.

Installation

Install the extension with pip:

pip install flask-chartjs-manager

Usage

Once installed the Flask-ChartJS-Manager is easy to use.Let's walk through setting up a basic application. Also please note that this is a very basic guide: we will be taking shortcuts here that you should never take in a real application.

To begin we'll set up a Flask app:

import flask

app = flask.Flask(__name__)

Flask-ChartJS works via a ChartJS object. To kick things off, we'll set up the chartjs manager by instantiating it and telling it about our Flask app:

from flask_chartjs import ChartJSManager

chartjs_manager = ChartJSManager()
chartjs_manager.init_app(app)

This will make available the load_chartjs function into the templates context so you could load the javascript package easily, like this.

<head>
  {{ load_chartjs() }}
</head>

Now we will construct a basic chart.

from flask_chartjs import Chart, DataSet
from flask import render_template

@app.get('/chart-example')
def chart_example():
    
    chart = Chart('income-outcome', 'bar') # Requires at least an ID and a chart type.
    
    dataset_income = DataSet('Income', [100,200,300])
    dataset_outcome = DataSet('OutCome', [50,100,150])
    
    chart.data.add_labels('jan', 'feb', 'mar')
    chart.data.add_dataset(dataset_income)
    chart.data.add_dataset(dataset_outcome)

    return render_template('path/to/template.html', my_chart=chart)

Once created you can pass it to a render_template and use it likewise.

<!-- load_chartjs() must be called before this line -->
<div class="my-classes">{{ render_chart(my_chart) }}</div>

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

flask_chartjs_manager-0.1.9.tar.gz (4.5 kB view hashes)

Uploaded Source

Built Distribution

flask_chartjs_manager-0.1.9-py3-none-any.whl (5.2 kB view hashes)

Uploaded 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