Create a demo viewer app

オープン
  • 何か問題がありますか？
#24 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
python
領域
desktop

調査の方向性

まず traitsui.extras.demo と TraitsUI examples/tutor.py を比較し、Envisage Tasks と既存の IPython 統合がどのように構成されているかを確認します。アーキテクチャを提案する前に、要求された viewer をスコープが独立した部分に分割します。Issue に列挙されたデモの検出、編集、実行、同期、拡張ポイント、およびオプションの検索動作が実装され、テストされていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

enhancement

This is a large issue that should take some time to complete, and have multiple sub-parts. The goal is to create a comprehensive demo application that is an improved version of traitsui.extras.demo and TraitsUI examples/tutor.py that has the following features:

  • is an Envisage + Tasks application
  • the Task has a basic layout of:
    • a dockpane tree view of examples/demos
    • a dockpane showing an HTML description of the selected item in the tree view
    • a dockpane showing the source code of the selected item in the tree view (if any). This should be user editable, and changes applied to the example/demo when it is next run.
    • a dockpane with an IPython prompt (this can be more-or-less taken from Envisage)
    • a central pane with editors that show the content of running demos (if they are embeddable).
    • dockpanes with stdout, stderr and logging information for the active editor
  • if an item is activated in the tree view (usually double-click on it) or if a run action is fired while an item is selected, the example/demo is executed:
    • some items may be descriptive only, in which case the run action should be disabled
    • some items may not have any UI component (especially Traits examples) and so may make sense to just run in the IPython kernel
    • some items may run an external script in a sub-process (eg. a more complex application)
    • some items may pop up a modal or non-modal dialog
    • but many will create an object that can be displayed in an editor in the central pane.
    • appropriate values from the example/demo's namespace will be populated into the IPython kernel so users can inspect/interact with them
  • if the active editor is changed, the selection should track that (so the description and code dockpanes are synchronized with the active editor).
  • the examples/demos are contributed via extension points so new libraries can make their own demos available to the application
  • plugins should be able to contribute new example/demo types (eg. the Kiva example plugin should be able to contribute a new example/demo type for displaying a graphics context that the example code draws into).

If done well, this application should be useable without Envisage, so we can use a basic Tasks-only version of the application for Pyface/TraitsUI demos/examples, and then have better extensions for Enable and Chaco examples. This may mean that significant parts of the code live in TraitsUI, Enable and Chaco.

Icing on the cake would be to add example search via something like Whoosh.

主要言語
Python
スター
5
フォーク
3
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

enthought/ets-examples のほかの issue

enthought/ets-examples の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。