Skip to content

README.jp.md

Latest commit

 

History

History
105 lines (74 loc) · 5.22 KB

README.jp.md

File metadata and controls

105 lines (74 loc) · 5.22 KB

pyvchart logo

pyvchart

Python ❤️ VChart = pyvchart

Github Actions Status Codecov

Contributions welcome License

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

📣 はじめに

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

✨ 特徴

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

🔰 インストール

pip インストール

# インストール
# 【❕注意❕】現在、PyPI に長期間メンテナンスされていない同名のプロジェクトが存在するため、wheel を PyPI にアップロードすることができません。
$ pip install pyvchart -U

# 一時的な解決策
$ pip install git+https://github.com/pyvchart/pyvchart@v0.1.0

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

# バージョン v1 以上をインストール
$ git clone https://github.com/pyvchart/pyvchart.git
$ cd pyvchart
$ 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 で確認できます

💡 貢献

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

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

また、pyvchart に多くの例を提供してドキュメントを充実させることも歓迎します。ドキュメントプロジェクトは pyvchart/website にあります

📃 ライセンス

MIT ©sunhailin-Leo