Skip to main content

This is a gantt chart drawing library

Project description

PyPI - Version Downloads

elegantt

Overview

elegantt is gantt chart drawing library designed for developers and project managers who need to visualize project timeline efficiently. With support for both CSV and Mermaid formats. elegantt provides the flexibility and functionality you need to keep your projects on task.

Features

  • Simpe and intuitive API
  • Supports both CSV and Mermaid Gantt chart formats
  • customizable chat size and colors
  • Command line interface for quick usage
  • Cross-platform support

Installation

Install elegantt via pip:

pip install elegantt

Fonts Installation

To ensure proper rendering of text, install the necessary fonts:

on Ubuntsu

apt install fonts-noto-cjk

on RedHat/RockyLinux

yum install google-noto-sans-cjk-ttc-fonts.noarch

Usage

Command Line interface

Generate a Gantt chart from CSV file:

eletentt sample.csv

CSV Format Example

2023-01-01,2023-01-04,Task 1
2023-01-02,2023-01-05,Task 2
2023-01-04,2023-01-06,Task 3

generate a Gantt chart from a Mermaid format:

eletentt sample_mermaid.txt

Mermaid Format Example

gantt
    section task a
    task b            :active,  des2, 2024-05-20, 4d
    task c            :         des3, after des2, 7d

generate a Gantt chart from a Mermaid format:

eletentt sample_markdown.md

Markdown Format Example

|2024-06-15|2024-06-18|task a|
|2024-06-20|2d        |task b|
|3d        |          |task c|

As a library

integrate elegantt into your python projects for advanced usage:

import elegantt

# Define chart properties
chartsize = (720,320)
bgcolor = (255,255,255)

# Create a Gant chart object
gchart = elegantt.EleGantt( chartsize, bgcolor, today="2019-10-15")

# Draw calendar and campains
gchart.draw_calendar()
gchart.draw_campain("2019-10-15","2019-10-18","Task 1")
gchart.draw_campain("2019-10-20","2019-10-23","Task 2")
gchart.draw_campain("2019-10-24","2019-10-30","Task 3")
gchart.save("gantt_chart.png")

or auto_draw for mermaid or markdown format

import elegantt

s = """
    task a  :done, des1, 2024-06-15, 2024-06-18
    task b  :active, des2, 2024-06-20, 2d
    task c  :         des3, after des2, 3d
"""
gchart = elegantt.EleGantt(today="2024-06-18")
gchart.auto_draw(s, mode="mermaid")
gchart.save("gantt_chart.png")

Lisence

This project is licensed under the MIT License, see the LICENSE.txt file for details

Contributing

We welcome contributions!

Support

For support or any questions, feel free to open an issue on our Github page.

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

elegantt-0.0.6.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

elegantt-0.0.6-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file elegantt-0.0.6.tar.gz.

File metadata

  • Download URL: elegantt-0.0.6.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.10

File hashes

Hashes for elegantt-0.0.6.tar.gz
Algorithm Hash digest
SHA256 4bf20785defa7f24e3e0b96d9e29088746d1527d4f345ad4bd43d3eab447f49e
MD5 7645ab8cd9ad6f0b7fa7a08ec7655509
BLAKE2b-256 bd12605c89b62bd2a4757084fc098006db435ebf46ca541d554310e533d20224

See more details on using hashes here.

File details

Details for the file elegantt-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: elegantt-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.10

File hashes

Hashes for elegantt-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 399275dd667a1b2c30f6dea75b193b94f1462d7b72ccdf00a8a250493f9654ef
MD5 9d2121d10a1e9a3c0947405b6e534d9a
BLAKE2b-256 b74cfa3e512bfd7cd19b8a56d30ce4f4b893636d5c94b52590fbd26ddfaa0dca

See more details on using hashes here.

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