From 5cf811ad44a5b4fb692d6c2f590a0332f533e619 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Tue, 3 Sep 2019 04:34:30 +0200 Subject: [PATCH 1/2] some additions to contributing notes --- CONTRIBUTING.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fc39028..35a2549 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,46 @@ # CONTRIBUTING -This project was generated by the [dash-component-boilerplate](https://github.com/plotly/dash-component-boilerplate) it contains the minimal set of code required to create your own custom Dash component. +Welcome to dash-canvas! Contributions, bug reports, comments about the +package are very welcome. The project is hosted on +https://github.com/plotly/dash-canvas. +This project was initially generated by the +[dash-component-boilerplate](https://github.com/plotly/dash-component-boilerplate), +which contains the minimal set of code required to create your own custom +Dash component. + +## Structure of the code: + +- the source code of the ``dash_canvas.DashCanvas`` canvas reactive + object is the JavaScript React class in +``src/lib/components/DashCanvas.react.js``. If you are not familiar with +React and JavaScript, [this +tutorial](https://dash.plot.ly/react-for-python-developers) is a good +primer. In order to build the Javascript component: excecute at the root +of the package + +``` +npm run build:all +``` + +- the ``dash_canvas/utils`` submodule contains utility functions in order + to use annotations retrieved from the DashCanvas object for further +image processing. + +- for examples of applications using dash-canvas, see the https://github.com/plotly/canvas-portal. These examples show in particular how to write callbacks using the DashCanvas object properties. + +## Testing + +For testing the DashCanvas objects using Selenium + +``` +pytest tests --webdriver Chrome +``` + +(or using another webdriver). + +For testing the Python package and utility functions + +``` +pytest dash_canvas +``` From f8336c721a276c29162dc87532aaf9cbe9cbe177 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Thu, 5 Sep 2019 21:56:50 -0400 Subject: [PATCH 2/2] Update CONTRIBUTING.md Co-Authored-By: Joris Vankerschaver --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 35a2549..38b1d6e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ Dash component. ``src/lib/components/DashCanvas.react.js``. If you are not familiar with React and JavaScript, [this tutorial](https://dash.plot.ly/react-for-python-developers) is a good -primer. In order to build the Javascript component: excecute at the root +primer. In order to build the Javascript component: execute at the root of the package ```