# echarts-python

**Repository Path**: lnkdel/echarts-python

## Basic Information

- **Project Name**: echarts-python
- **Description**: Generate Echarts options with Python.
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2020-07-15
- **Last Updated**: 2024-11-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Echarts for Python
==================

An unofficial Echarts options generator with Python.

.. image:: https://img.shields.io/pypi/v/echarts-python.svg
   :target: https://pypi.python.org/pypi/echarts-python/
   :alt: Latest Version
.. image:: https://travis-ci.org/yufeiminds/echarts-python.svg?branch=develop
   :target: https://travis-ci.org/yufeiminds/echarts-python
   :alt: Travis CI Status
.. image:: https://codecov.io/github/yufeiminds/echarts-python/coverage.svg?branch=develop
   :target: https://codecov.io/github/yufeiminds/echarts-python?branch=master
   :alt: Codecov Status
.. image:: https://readthedocs.org/projects/echarts-python/badge/?version=latest
   :target: http://echarts-python.readthedocs.org/en/latest/?badge=latest
   :alt: Doc Status

-  Free software: MIT license
-  Documentation: http://echarts-python.readthedocs.io/en/stable/ (NOT Ready)
-  Online demo: https://yufeiminds.github.io/echarts-python/ (NOT Ready)

This repo still on developing (ALPHA), DON'T USE IT IN PRODUCTION.

Installation
------------

Installing **echarts-python** with pip ::

  $ pip install echarts-python

Current version for `Echarts 3.1.6 <http://echarts.baidu.com/option.html>`_

Basic Usage
-----------

.. code-block:: python

    from echarts import Echart, Legend, Bar, Axis

    chart = Echart('GDP', 'This is a fake chart')
    chart.use(Bar('China', [2, 3, 4, 5]))
    chart.use(Legend(['GDP']))
    chart.use(Axis('category', 'bottom', data=['Nov', 'Dec', 'Jan', 'Feb']))

The `chart.json` property will be

.. code-block:: javascript

    {
        "title": {
            "text": "GDP",
            "subtext": "This is a fake chart"
        },
        "series": [
            {
                "type": "bar",
                "data": [
                    2,
                    3,
                    4,
                    5
                ],
                "name": "China"
            }
        ],
        "legend": {
            "y": "top",
            "x": "center",
            "data": [
                "GDP"
            ],
            "orient": "horizontal"
        },
        "xAxis": [
            {
                "position": "bottom",
                "data": [
                    "Nov",
                    "Dec",
                    "Jan",
                    "Feb"
                ],
                "type": "category"
            }
        ],
        "yAxis": {}
    }

on Mac OSX, you also can execute ::

    chart.plot()

and invoke a browser to display the chart.


Contribution
------------

This package authored by Hsiaoming Yang <me@lepture.com> in 2014.

If you have any question or want to improve this repository, welcome to create
an `issue <https://github.com/yufeiminds/echarts-python/issues>`__
or `pull requests <https://github.com/yufeiminds/echarts-python/pulls>`__ .

This repo is maintained by Yufei Li <yufeiminds@gmail.com> now,
you can also send a email to me.