Skip to content

Latest commit

 

History

History
108 lines (75 loc) · 4.69 KB

README.en.md

File metadata and controls

108 lines (75 loc) · 4.69 KB

pyvchart logo

pyvchart

Python ❤️ VChart = pyvchart

Github Actions Status Codecov

Contributions welcome License

中文 README | English README | 日本語（にほんご）README

📣 Introduction

VisActor/VChart is a core chart component library of the open-source visualization solution VisActor by ByteDance. It is based on the visualization grammar library VGrammar and the rendering engine VRender, providing not only data presentation but also support for animation orchestration for narrative scenarios, rich interaction capabilities, and customizable chart styles. The simple and easy-to-use configuration greatly reduces the learning cost for users. Python, with its expressive syntax, is well-suited for data processing and AI scenarios. When data analysis and modeling meet data visualization, pyecharts and py-vchart were born.

✨ Features

  • API design similar to pyecharts, smooth and fluent usage, supports method chaining
  • Includes all charts from VChart, everything you need
  • Supports mainstream Notebook environments, Jupyter Notebook, JupyterLab (Coming soon...)
  • Can be easily integrated into mainstream Web frameworks such as Flask, Sanic, Django (Coming soon...)
  • Highly flexible configuration options, allowing for the creation of beautiful charts with ease
  • Detailed documentation and examples to help developers get started quickly

🔰 Installation

pip installation

# Install
$ pip install py-vchart -U

Source code installation

# Install
$ git clone https://github.com/VisActor/py-vchart.git
$ cd py-vchart
$ pip install -r requirements.txt
$ python setup.py install

📝 Usage

Usage examples are here：Examples

⛏ Code Quality

Unit Testing

$ pip install -r test/requirements.txt
$ make

Integration Testing

Using GitHub Actions for continuous integration.

Code Style

Using flake8, Codecov, and pylint to improve code quality.

😉 Author

pyvchart is mainly developed and maintained by the following developers

More contributor information can be found at pyvchart/graphs/contributors

💡 Contribution PRs Welcome

If you wish to contribute, please read the Code of Conduct and Contribution Guidelines.

A small stream can become a vast ocean!

We look forward to more developers joining the development of pyvchart. We will ensure that PRs are reviewed promptly and replies are timely. However, when submitting a PR, please ensure:

  1. All unit tests pass. If it's a new feature, please add corresponding unit tests.
  2. Follow the development guidelines and format the code using black and isort ($ pip install -r requirements-dev.txt).
  3. Update relevant documentation if necessary.

We also warmly welcome developers to provide more examples and help improve the documentation. The documentation project is located at pyvchart/website (Documentation is in preparation...)

📃 License

MIT ©VisActor