Skip to main content

draws gantt chart using frappe-gantt.js for pyexcel data

Project description

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

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.

If you are an individual, you are welcome to support me too on patreon and for however long you feel like to. As a patreon, you will receive early access to pyexcel related contents.

With your financial support, I will be able to invest a little bit more time in coding, documentation and writing interesting posts.

Introduction

pyexcel-gantt draws gantt chart using frappe-gantt.js for pyexcel data. Credit goes to frappe’s gantt chart

Here is a sample csv file:

id,name,start,end,progress,dependencies,custom_class
Task 1,Writing pyexcel-gantt,2017-07-17,2017-07-18,80,,
Task 2,Test pyexcel-gantt,2017-07-19,2017-07-20,10,Task 1,,
Task 3,Write up the documentation,2017-07-21,2017-07-22,0,Task 1,,
Task 4,Release pyexcel-gantt,2017-07-23,2017-07-23,0,"Task 2, Task 3",,bar-milestone

What you can do is to view it with pyexcel’s command line interface:

pyexcel view –in-browser –output-file-type gantt.html demo/tasks.csv

https://github.com/pyexcel/pyexcel-gantt/raw/master/pyexcel-gantt.gif

Programmatically, you can do the following:

import pyexcel as p


p.save_as(file_name='tasks.csv',
          dest_file_name='tasks.gantt.html')

Alternatively, you can save the file as:

$ pyexcel transcode tasks.csv tasks.gantt.html

Installation

You can install it via pip:

$ pip install pyexcel-gantt

or clone it and install it:

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

Development guide

Development steps for code changes

  1. git clone https://github.com/pyexcel/pyexcel-gantt.git

  2. cd pyexcel-gantt

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

Once you have finished your changes, please provide test case(s), relevant documentation and update CHANGELOG.rst.

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

How to update test environment and update 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 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.

Acceptance criteria

  1. Has Test cases written

  2. Has all code lines tested

  3. Passes all Travis CI builds

  4. Has fair amount of documentation if your change is complex

  5. Agree on NEW BSD License for your contribution

License

New BSD License

Change log

0.0.1 - unreleased

Initial release

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

pyexcel-gantt-0.0.1.tar.gz (63.5 kB view details)

Uploaded Source

Built Distribution

pyexcel_gantt-0.0.1-py2.py3-none-any.whl (64.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pyexcel-gantt-0.0.1.tar.gz.

File metadata

  • Download URL: pyexcel-gantt-0.0.1.tar.gz
  • Upload date:
  • Size: 63.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pyexcel-gantt-0.0.1.tar.gz
Algorithm Hash digest
SHA256 71037df50900da9c9658da4085d32dc0658207767a7344191d98582edd6c808e
MD5 fa3ca00e273cdb78928eeb42a9c1f3e6
BLAKE2b-256 c14d62064e87d4ef761e197d98f0543a10d1f7a4745dcf31ee5ef5d0df448183

See more details on using hashes here.

File details

Details for the file pyexcel_gantt-0.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pyexcel_gantt-0.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a57c983cf1fa45922001b494753bf6361117d27a49d25e66c40782721281a356
MD5 ccaf5d2e160d121479e964358cd2d558
BLAKE2b-256 97d6d7c584561156a577a16b177661b3b2ac95f9c38db073004084337656ed2c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page