Skip to content

Commit

Permalink
Update to drawio 21.1.6, use main branch (#115)
Browse files Browse the repository at this point in the history
  • Loading branch information
bollwyvl authored Apr 11, 2023
1 parent be9c5d8 commit 59b2750
Show file tree
Hide file tree
Showing 32 changed files with 126 additions and 138 deletions.
2 changes: 1 addition & 1 deletion conda.recipe/meta.yaml → .github/conda.recipe/meta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

{% set build_number = 0 %}

{% set url_base = RECIPE_DIR.replace("\\", "/") + "/../dist" %}
{% set url_base = RECIPE_DIR.replace("\\", "/") + "/../../dist" %}
{% if not url_base.startswith("/") %}
{% set url_base = "/" + url_base %}
{% endif %}
Expand Down
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Thanks for contributing to ipydrawio!
Please fill out the following items to submit a pull request.
See the contributing guidelines for more information:
https://github.com/deathbeds/ipydrawio/blob/master/CONTRIBUTING.md
https://github.com/deathbeds/ipydrawio/blob/main/CONTRIBUTING.md
-->

## References
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@
on:
push:
branches:
- master
- main
pull_request:
branches:
- master
- '*'

concurrency:
group: ${{ github.ref }}
Expand Down
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@

##### @deathbeds/ipydrawio-notebook 1.3.0

##### @deathbeds/ipydrawio-webpack 21.1.400
##### @deathbeds/ipydrawio-webpack 21.1.600

- updates to [drawio v21.1.4](https://github.com/jgraph/drawio/releases/tag/v21.1.4)
- updates to [drawio v21.1.6](https://github.com/jgraph/drawio/releases/tag/v21.1.6)
- includes
[mermaidjs 10.0.0](https://github.com/mermaid-js/mermaid/releases/tag/v10.0.0)

Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
- improving the binder demo
- improving [continuous integration][ci] and [developer experience][dodo]

[roadmap]: https://github.com/deathbeds/ipydrawio/blob/master/ROADMAP.md
[ci]: https://github.com/deathbeds/ipydrawio/blob/master/.github/workflows/ci.yml
[dodo]: https://github.com/deathbeds/ipydrawio/blob/master/dodo.py
[roadmap]: https://github.com/deathbeds/ipydrawio/blob/main/docs/ROADMAP.ipynb
[ci]: https://github.com/deathbeds/ipydrawio/blob/main/.github/workflows/ci.yml
[dodo]: https://github.com/deathbeds/ipydrawio/blob/main/dodo.py

## Prerequisites

Expand Down
32 changes: 15 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ pip install ipydrawio[all]
- or follow the [Installation instructions](#installation) and **Start JupyterLab**
- Open a diagram, by doing one of:
- Creating a
<img src="https://raw.githubusercontent.com/deathbeds/ipydrawio/master/packages/ipydrawio/style/img/drawio.svg" width="24"/>
<img src="https://raw.githubusercontent.com/deathbeds/ipydrawio/main/packages/ipydrawio/style/img/drawio.svg" width="24"/>
Diagram\_ from the [Launcher][]
- Uploading a diagram created on [diagrams.net](https://diagrams.net) with the _[File
Manager][]_ and double clicking it
Expand Down Expand Up @@ -191,49 +191,47 @@ See the License for the specific language governing permissions and
limitations under the License.
```
[apache 2.0]: https://github.com/deathbeds/ipydrawio/blob/master/LICENSE.txt
[apache 2.0]: https://github.com/deathbeds/ipydrawio/blob/main/LICENSE.txt
[@jgraph/drawio]: https://github.com/jgraph/drawio
[@jgraph/draw-image-export2]: https://github.com/jgraph/draw-image-export2
[jupyterlab]: https://github.com/jupyterlab/jupyterlab
[drawio]: https://www.diagrams.net
[quantstack/jupyterlab-drawio]: https://github.com/QuantStack/jupyterlab-drawio
[contributors]: https://github.com/deathbeds/ipydrawio/graphs/contributors
[history]: https://github.com/deathbeds/ipydrawio/blob/master/CHANGELOG.md
[history]: https://github.com/deathbeds/ipydrawio/blob/main/CHANGELOG.md
[binder]:
http://mybinder.org/v2/gh/deathbeds/ipydrawio/master?urlpath=lab/tree/docs/Poster.dio.svg
http://mybinder.org/v2/gh/deathbeds/ipydrawio/main?urlpath=lab/tree/docs/Poster.dio.svg
[binder-badge]: https://mybinder.org/badge_logo.svg
[workflow-badge]:
https://github.com/deathbeds/ipydrawio/workflows/.github/workflows/ci.yml/badge.svg
[workflow]:
https://github.com/deathbeds/ipydrawio/actions?query=branch%3Amaster+workflow%3A.github%2Fworkflows%2Fci.yml
[roadmap]: https://github.com/deathbeds/ipydrawio/blob/master/docs/ROADMAP.ipynb
https://github.com/deathbeds/ipydrawio/actions?query=branch%3Amain+workflow%3A.github%2Fworkflows%2Fci.yml
[roadmap]: https://github.com/deathbeds/ipydrawio/blob/main/docs/ROADMAP.ipynb
[conda-badge]: https://img.shields.io/conda/vn/conda-forge/ipydrawio
[conda]: https://anaconda.org/conda-forge/ipydrawio
[pypi-badge]: https://img.shields.io/pypi/v/ipydrawio
[pypi]: https://pypi.org/project/ipydrawio/
[npm]: https://npmjs.com/package/@deathbeds/ipydrawio
[npm-badge]: https://img.shields.io/npm/v/@deathbeds/ipydrawio
[cov-badge]:
https://codecov.io/gh/deathbeds/ipydrawio/branch/master/graph/badge.svg?token=9B74VKHQDK
https://codecov.io/gh/deathbeds/ipydrawio/branch/main/graph/badge.svg?token=9B74VKHQDK
[cov]: https://codecov.io/gh/deathbeds/ipydrawio
[docs-badge]: https://readthedocs.org/projects/ipydrawio/badge/?version=latest
[docs]: https://ipydrawio.rtfd.io
[contributing]: https://github.com/deathbeds/ipydrawio/blob/master/CONTRIBUTING.md
[contributing]: https://github.com/deathbeds/ipydrawio/blob/main/CONTRIBUTING.md
[documents]:
https://github.com/deathbeds/ipydrawio/blob/master/docs/Diagram%20Document.ipynb
https://github.com/deathbeds/ipydrawio/blob/main/docs/Diagram%20Document.ipynb
[rich display]:
https://github.com/deathbeds/ipydrawio/blob/master/docs/Diagram%20Rich%20Display.ipynb
[widgets]:
https://github.com/deathbeds/ipydrawio/blob/master/docs/Diagram%20Widgets.ipynb
https://github.com/deathbeds/ipydrawio/blob/main/docs/Diagram%20Rich%20Display.ipynb
[widgets]: https://github.com/deathbeds/ipydrawio/blob/main/docs/Diagram%20Widgets.ipynb
[puppeteer]: https://github.com/puppeteer/puppeteer
[@jgraph/draw-image-export2]: https://github.com/jgraph/draw-image-export2
[apt-txt]: https://github.com/deathbeds/ipydrawio/blob/master/.binder/apt.txt
[apt-txt]: https://github.com/deathbeds/ipydrawio/blob/main/.binder/apt.txt
[poster-min]:
https://raw.githubusercontent.com/deathbeds/ipydrawio/master/docs/_static/images/poster.png
[poster]:
https://raw.githubusercontent.com/deathbeds/ipydrawio/master/docs/Poster.dio.svg
https://raw.githubusercontent.com/deathbeds/ipydrawio/main/docs/_static/images/poster.png
[poster]: https://raw.githubusercontent.com/deathbeds/ipydrawio/main/docs/Poster.dio.svg
[roadmap]:
https://nbviewer.jupyter.org/github/deathbeds/ipydrawio/blob/master/docs/ROADMAP.ipynb
https://nbviewer.jupyter.org/github/deathbeds/ipydrawio/blob/main/docs/ROADMAP.ipynb
[command palette]:
https://jupyterlab.readthedocs.io/en/stable/user/commands.html?highlight=command%20palette
[launcher]:
Expand Down
40 changes: 0 additions & 40 deletions ROADMAP.md

This file was deleted.

4 changes: 2 additions & 2 deletions demo/jupyter_lite_config.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"LiteBuildConfig": {
"cache_dir": "../build/.cache/.lite",
"federated_extensions": [
"../py_packages/ipydrawio/dist/ipydrawio-1.3.0-py3-none-any.whl",
"https://conda.anaconda.org/conda-forge/noarch/bqplot-0.12.38-pyhd8ed1ab_0.conda",
Expand All @@ -12,8 +13,7 @@
"ignore_sys_prefix": true,
"lite_dir": ".",
"output_archive": "../build/demo/ipydrawio-lite-1.3.0.tgz",
"output_dir": "../build/demo",
"cache_dir": "../build/.cache/.lite"
"output_dir": "../build/demo"
},
"PipliteAddon": {
"piplite_urls": [
Expand Down
46 changes: 33 additions & 13 deletions docs/ROADMAP.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
"\n",
"- the out-of-band `puppeteer` provisioning step should be more reliable\n",
" - make a separate `conda-forge` package of `puppeteer`/`drawio-export` upstream?\n",
" - use [pyppeteer](https://github.com/pyppeteer/pyppeteer)?\n",
"- the download and hosting of the drawio assets should be as efficient as possible"
]
},
Expand Down Expand Up @@ -58,7 +57,8 @@
" - JupyterLab UI components\n",
" - JupyterHub UI components\n",
" - Jupyter workflows\n",
" - Jupyter architecture icons"
" - Jupyter architecture icons\n",
" - Jupyter color schemes"
]
},
{
Expand All @@ -67,7 +67,18 @@
"source": [
"## Easy to Compute\n",
"\n",
"> Users should be able to use diagrams as part of an interactive, literate, computational process."
"> Users should be able to use diagrams as part of an interactive, literate, computational process.\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Widgets\n",
"\n",
"- create lightweight, editable models of live graph items\n",
"- better encapsulate libraries as widget models\n",
"- enable interaction rules for creating games and simulations"
]
},
{
Expand Down Expand Up @@ -102,32 +113,41 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### Editable PDF\n",
"## Easy to Collaborate\n",
"\n",
"- enabled _Editable PDF_\n",
" - use [pdf.js][]\n",
"> Users should find it easy to work with diagrams as part of a team."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### `jupyter-videochat` integration\n",
"\n",
"[pdf.js]: https://github.com/mozilla/pdf.js/"
"- Use [jupyter-videochat][] JSON bus to collaborate with other team members\n",
"\n",
"[jupyter-videochat]: https://github.com/yuvipanda/jupyter-videochat"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Easy to Collaborate\n",
"### `jupyterlab-deck` integration\n",
"\n",
"- Users should find it easy to work with diagrams as part of a team."
"- integrate with [jupyterlab-deck](https://github.com/deathbeds/jupyterlab-deck) offering layer and page navigation, as well as _Explore_ "
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### jupyter-videochat integration\n",
"### Editable PDF\n",
"\n",
"- Use [jupyter-videochat][] JSON bus to collaborate with other team members\n",
"- enabled _Editable PDF_\n",
" - use [pdf.js][]\n",
"\n",
"[jupyter-videochat]: https://github.com/yuvipanda/jupyter-videochat"
"[pdf.js]: https://github.com/mozilla/pdf.js/"
]
}
],
Expand All @@ -147,7 +167,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.0"
"version": "3.11.3"
},
"toc-autonumbering": true,
"toc-showcode": true,
Expand Down
2 changes: 2 additions & 0 deletions docs/about/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# About

```{toctree}
:maxdepth: 3
../ROADMAP.ipynb
changelog
```
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
html_context = {
"github_user": "deathbeds",
"github_repo": "ipydrawio",
"github_version": "master",
"github_version": "main",
"doc_path": "docs",
"demo_tarball": f"_static/ipydrawio-lite-{release}.tgz",
}
Expand Down
28 changes: 19 additions & 9 deletions docs/tutorials/designing-jupyter-extensions/index.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"metadata": {},
"source": [
"```{note}\n",
"This tutorial looks at how different kinds of diagram artifacts can be created that support the process of building _Jupyter Extensions_, using IPyDrawio itself as a subject. Each of the images below rendered directly in the browser for this documentation, as well as editable within IPyDrawio.\n",
"This tutorial looks at how different kinds of diagram artifacts can be created that support the process of building _Jupyter Extensions_, using IPyDrawio itself as a subject. Each of the images below renders directly in the browser for this documentation, and ais editable within IPyDrawio.\n",
"```"
]
},
Expand All @@ -31,7 +31,7 @@
"id": "7a5ef077-3d16-4e61-ad47-39b03eb60612",
"metadata": {},
"source": [
"Extensions for [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html) and [Jupyter Server](https://jupyter-server.readthedocs.io/en/latest/developers/extensions.html?highlight=distributing#distributing-a-server-extension) often developed, and can be distributed, together as a single Python package. While a single author can build, test, document and ship new features _without_ any kinds of pictures, individuals and especially team- and community-driven processes can be enhanced by different visual artifacts that _live next to the code_."
"Extensions for [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html) and [Jupyter Server](https://jupyter-server.readthedocs.io/en/latest/developers/extensions.html?highlight=distributing#distributing-a-server-extension) are often developed, and can be distributed, together as a single Python package. While a single author can build, test, document, and ship new features _without_ any kinds of pictures, individual, and especially team- and community-driven, processes can be enhanced by different visual artifacts that _live next to the code_."
]
},
{
Expand All @@ -51,7 +51,7 @@
"source": [
"## Gathering Ideas\n",
"\n",
"As you start thinking about your extension, who will use it, and how you might build it, IPyDrawio diagrams can capture structured problem-solving approaches effective at capturing, and then leveraging, visual concepts to capture goals and trade-offs."
"As you start thinking about your extension, who will use it, and how you might build it, IPyDrawio diagrams can enable structured problem-solving approaches effective at capturing, and then leveraging, visual concepts to capture goals and trade-offs."
]
},
{
Expand Down Expand Up @@ -83,6 +83,16 @@
"[mindmap]: ../../_static/tutorials/designing-jupyter-extensions/mindmap.dio.svg"
]
},
{
"cell_type": "markdown",
"id": "4201146e-6199-4841-92af-b97ac8b70e43",
"metadata": {},
"source": [
"```{note}\n",
"Newer versions of MermaidJS also [text-based mind maps](https://mermaid.js.org/syntax/mindmap.html). These are not yet available on many places where other MermaidJS diagrams work, such as GitHub.\n",
"```"
]
},
{
"cell_type": "markdown",
"id": "bec77aa2-80cf-4702-b222-5c40e021b4a1",
Expand Down Expand Up @@ -121,11 +131,11 @@
"id": "14fe2c2b-de91-4aee-92d1-179d9754468b",
"metadata": {},
"source": [
"### Mermaid Diagrams\n",
"### MermaidJS Diagrams\n",
"\n",
"The [mermaid.js](https://mermaid-js.github.io/mermaid) drawio plugin (enabled by default) provides a way to write pithy text descriptions, including:\n",
"The [mermaid.js](https://mermaid.js.org) drawio plugin (enabled by default) provides a way to write pithy text descriptions, including:\n",
"\n",
"> _Flowchart, Sequence diagram, Class Diagram, State Diagram, Entity Relationship Diagram, User Journey, Gantt, Pie Chart, Requirement Diagram_"
"> _Flowchart, Sequence diagram, Class Diagram, State Diagram, Entity Relationship Diagram, User Journey, Gantt, Pie Chart, Requirement Diagram, Mindmap, Timeline_"
]
},
{
Expand All @@ -134,7 +144,7 @@
"metadata": {},
"source": [
"```{note}\n",
"From the drawio menu, select _Insert_ ▸ _Advanced_ ▸ _Mermaid_. Paste some mermaid there. The resulting object will _not_ be editable with shape-editing tools, but you _will_ be able to adjust the mermaid syntax later by clicking on it, which can be worth _much_ more over time. \n",
"From the _drawio_ menu, select _Insert_ ▸ _Advanced_ ▸ _Mermaid_. Paste some mermaid there. The resulting object will _not_ be editable with shape-editing tools, but you _will_ be able to adjust the mermaid syntax later by clicking on it, which can be worth _much_ more over time. \n",
"```"
]
},
Expand Down Expand Up @@ -226,7 +236,7 @@
"source": [
"### Comps\n",
"\n",
"High-fidelity mockups, or \"comps,\" eventually provide the language used between the designer role and the developer role... even if these roles are filled by the same person."
"High-fidelity mockups, also known as \"composites\" or \"comps,\" eventually provide the language used between the designer role and the developer role... even if these roles are filled by the same person."
]
},
{
Expand Down Expand Up @@ -445,7 +455,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.0"
"version": "3.11.3"
}
},
"nbformat": 4,
Expand Down
2 changes: 1 addition & 1 deletion packages/ipydrawio-jupyter-templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pip install ipydrawio

This work is licensed under the [Apache-2.0] License.

[apache-2.0]: https://github.com/deathbeds/ipydrawio/blob/master/LICENSE.txt
[apache-2.0]: https://github.com/deathbeds/ipydrawio/blob/main/LICENSE.txt

```
Copyright 2023 ipydrawio contributors
Expand Down
Loading

0 comments on commit 59b2750

Please sign in to comment.