Skip to content

Latest commit

 

History

History
107 lines (63 loc) · 3.38 KB

README.rst

File metadata and controls

107 lines (63 loc) · 3.38 KB
Raw

pyexcel-chart - Let you focus on presentation, instead of chart types

https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png https://api.travis-ci.org/pyexcel/pyexcel-chart.svg?branch=master https://codecov.io/github/pyexcel/pyexcel-chart/coverage.png https://readthedocs.org/projects/pyexcel-chart/badge/?version=latest

pyexcel-chart is a tiny plugin of pyexcel to turn pyexcel data into chart graphics using pygal

Installation

You can install it via pip:

$ pip install pyexcel-chart

or clone it and install it:

$ git clone https://github.com/pyexcel/pyexcel-chart.git
$ cd pyexcel-chart
$ python setup.py install

Development guide

Development steps for code changes

  1. git clone https://github.com/pyexcel/pyexcel-chart.git
  2. cd pyexcel-chart

Upgrade your setup tools and pip. They are needed for development and testing only:

  1. pip install --upgrade setuptools pip

Then install relevant development requirements:

  1. pip install -r rnd_requirements.txt # if such a file exists
  2. pip install -r requirements.txt
  3. pip install -r tests/requirements.txt

In order to update test environment, and documentation, additional steps are required:

  1. pip install moban
  2. git clone https://github.com/pyexcel/pyexcel-commons.git commons
  3. make your changes in .moban.d directory, then issue command moban

What is rnd_requirements.txt

Usually, it is created when a dependent library is not released. Once the dependecy is installed(will be released), the future version of the dependency in the requirements.txt will be valid.

What is pyexcel-commons

Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in pyexcel-commons project.

What is .moban.d

.moban.d stores the specific meta data for the library.

How to test your contribution

Although nose and doctest are both used in code testing, it is adviable that unit tests are put in tests. doctest is incorporated only to make sure the code examples in documentation remain valid across different development releases.

On Linux/Unix systems, please launch your tests like this:

$ make

On Windows systems, please issue this command:

> test.bat

License

New BSD License

Support the project

If your company has embedded pyexcel and its components into a revenue generating product, please support me on patreon to maintain the project and develop it further.