README.jp.md

March 10, 2025 · View on GitHub

pyvchart logo

pyvchart

Python ❤️ VChart = pyvchart

Github Actions Status Codecov

Contributions welcome License

日本語 README | 英語 README | 日本語（にほんご）README

📣 はじめに

VisActor/VChart は、字節ジャンプトがオープンソース化したビジュアル化ソリューション VisActor のコアチャートコンポーネントライブラリです。これはビジュアル化文法ライブラリ VGrammar とレンダリングエンジン VRender を基に構築されており、データの表示だけでなく、ナレーシナリオ向けのアニメーション編成、豊富なインタラクティブ機能、カスタマイズ可能なチャートスタイルもサポートしています。シンプルで使いやすい設定により、ユーザーの学習コストが大幅に削減されます。一方、Python は表現力豊かな言語であり、データ処理やAIなどの分野で非常に適しています。データ分析やモデリングがデータビジュアライゼーションと組み合わさったときに、pyecharts と py-vchart が生まれました。

✨ 特徴

  • pyecharts に似た API 設計、スムーズでフローリングした使用感、メソッドチェーンのサポート
  • VChart のすべてのチャートを含む、必要なものが揃っている
  • Jupyter Notebook、JupyterLab (近日公開予定) などの主流の Notebook 環境をサポート
  • Flask、Sanic、Django (近日公開予定) などの主流の Web フレームワークへの容易な統合
  • 高度に柔軟な設定オプション、美しいチャートを簡単に作成できる
  • 開発者を手助けするための詳細なドキュメントと例

🔰 インストール

pip インストール

# インストール
$ pip install py-vchart -U

ソースコードインストール

# バージョン
$ git clone https://github.com/VisActor/py-vchart.git
$ cd py-vchart
$ pip install -r requirements.txt
$ python setup.py install

📝 使用方法

使用例はここにあります：Examples

⛏ コード品質

ユニットテスト

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

統合テスト

GitHub Actions を使用して継続的インテグレーション環境を構築しています。

コードスタイル

flake8, Codecov, pylint を使用してコード品質を向上させています。

😉 作者

pyvchart は以下の開発者が開発およびメンテナンスを行っています

他の貢献者の情報は pyvchart/graphs/contributors で確認できます

💡 コントリビューション PRs Welcome

コントリビュートを希望する場合は、行動規範 と コントリビューションガイドライン をお読みください。

細流は大海となる！

より多くの開発者が pyvchart の開発に参加することを楽しみにしています。PR は迅速にレビューされ、タイムリーな返信が行われます。ただし、PR を提出する際には以下の点にご注意ください：

  1. 全てのユニットテストがパスすること。新機能の場合、対応するユニットテストを追加してください。
  2. 開発ガイドラインに従い、black および isort を使用してコードをフォーマットしてください（$ pip install -r requirements-dev.txt）。
  3. 必要であれば、関連ドキュメントを更新してください。

また、開発者の方々には、より多くのサンプルを提供し、ドキュメントの改善に協力していただくことを歓迎します。ドキュメントプロジェクトは pyvchart/website にあります (ドキュメントは準備中...)

📃 ライセンス

MIT ©VisActor