d3blocks 2.2.0__tar.gz → 2.3.0__tar.gz

{d3blocks-2.2.0 → d3blocks-2.3.0}/MANIFEST.in

@@ -15,5 +15,7 @@ include d3blocks/maps/d3js/*
 include d3blocks/elasticgraph/d3js/*
 include d3blocks/radialgraph/d3js/*
 include d3blocks/flowgraph/d3js/*
+include d3blocks/sequence/d3js/*
+include d3blocks/erd/d3js/*
+include d3blocks/_shared/d3js/*
 include d3blocks/*
-recursive-include d3blocks/skills *

d3blocks-2.3.0/PKG-INFO

@@ -0,0 +1,181 @@
+Metadata-Version: 2.4
+Name: d3blocks
+Version: 2.3.0
+Summary: Python package d3blocks.
+Author-email: Erdogan Taskesen <erdogant@gmail.com>
+License-Expression: GPL-3.0-or-later
+Project-URL: Homepage, https://d3blocks.github.io/d3blocks
+Project-URL: Download, https://github.com/d3blocks/d3blocks/archive/{version}.tar.gz
+Keywords: Python,visualizations,interactive,javascript,d3js,d3blocks,network,graph,data visualization,web,extendable,extension,plugin,modular,customizable
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: Unix
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS
+Requires-Python: >=3
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: colourmap>=1.1.10
+Requires-Dist: datazets>=0.1.7
+Requires-Dist: d3graph>=3.2.0
+Requires-Dist: ismember>=1.0.1
+Requires-Dist: pandas
+Requires-Dist: tqdm
+Requires-Dist: requests
+Requires-Dist: jinja2
+Requires-Dist: scikit-learn
+Dynamic: license-file
+
+[![Python](https://img.shields.io/pypi/pyversions/d3blocks)](https://img.shields.io/pypi/pyversions/d3blocks)
+[![Pypi](https://img.shields.io/pypi/v/d3blocks)](https://pypi.org/project/d3blocks/)
+[![Docs](https://img.shields.io/badge/Sphinx-Docs-blue)](https://d3blocks.github.io/d3blocks/)
+[![LOC](https://sloc.xyz/github/d3blocks/d3blocks/?category=code)](https://github.com/d3blocks/d3blocks/)
+[![Downloads](https://static.pepy.tech/personalized-badge/d3blocks?period=month&units=international_system&left_color=grey&right_color=brightgreen&left_text=PyPI%20downloads/month)](https://pepy.tech/project/d3blocks)
+[![Downloads](https://static.pepy.tech/personalized-badge/d3blocks?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads)](https://pepy.tech/project/d3blocks)
+[![License](https://img.shields.io/badge/license-GPL3-green.svg)](https://github.com/d3blocks/d3blocks/blob/master/LICENSE)
+[![Forks](https://img.shields.io/github/forks/d3blocks/d3blocks.svg)](https://github.com/d3blocks/d3blocks/network)
+[![Open Issues](https://img.shields.io/github/issues/d3blocks/d3blocks.svg)](https://github.com/d3blocks/d3blocks/issues)
+[![Project Status](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
+[![Medium](https://img.shields.io/badge/Medium-Blog-black)](https://d3blocks.github.io/d3blocks/Documentation.html#medium-blog)
+![GitHub Repo stars](https://img.shields.io/github/stars/d3blocks/d3blocks)
+![GitHub repo size](https://img.shields.io/github/repo-size/d3blocks/d3blocks)
+[![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://github.com/d3blocks/d3blocks/blob/main/notebooks/d3blocks.ipynb)
+[![Donate](https://img.shields.io/badge/Support%20this%20project-grey.svg?logo=github%20sponsors)](https://d3blocks.github.io/d3blocks/Documentation.html#)
+[![skills.sh](https://skills.sh/b/d3blocks/d3blocks)](https://skills.sh/d3blocks/d3blocks)
+
+###
+
+<div>
+
+<a href="https://d3blocks.github.io/d3blocks/"><img src="https://github.com/d3blocks/d3blocks/blob/main/logo.png" width="275" align="left" /></a>
+``D3Blocks`` is a Python package that builds on the graphics of d3 javascript (d3js). It allows you to create the most visually attractive and useful charts with only a few lines of Python code!
+The [documentation pages](https://d3blocks.github.io/d3blocks/) contain detailed information about the working of the blocks with many examples. **⭐️ Star it if you like it ⭐️**
+</div>
+
+---
+
+<p align="center">
+  <a href="https://d3blocks.github.io/d3blocks">
+  <img src="https://github.com/d3blocks/d3blocks/blob/main/docs/figs/summary.png" width="600" />
+  </a>
+</p>
+
+---
+
+### Resources and Links
+- [**Example Notebooks**](https://d3blocks.github.io/d3blocks/Documentation.html#google-colab-notebooks)
+- [**Documentation**](https://d3blocks.github.io/d3blocks)
+- [**Bug Reports and Feature Requests**](https://github.com/d3blocks/d3blocks/issues)
+
+### Blogs
+- [**Medium Blog**](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510)
+- [**Substack with podcast**](https://erdogant.substack.com/p/d3blocks-the-python-library-to-create)
+- [**Gumroad Blogs with podcast**](https://erdogant.gumroad.com/l/d3blocks-the-python-library-to-create-interactive-standalone-and-beautiful-d3-js-charts)
+
+-------------------------------------------------------------------------
+### [Available charts](https://d3blocks.github.io/d3blocks/)
+
+
+|  nr |  Block                                                                             |    Function                  |    More Information                                                                 |
+|-----|------------------------------------------------------------------------------------|------------------------------|-------------------------------------------------------------------------|
+|  1  | [D3graph](https://d3blocks.github.io/d3blocks/d3graph.html)                | ``` d3.d3graph() ```         | [D3graph](https://medium.com/data-science-collective/how-to-turn-any-network-into-an-interactive-knowledge-graph-to-discover-hidden-insights-f49fae4757ff)                                  |
+|  2  | [Radialgraph](https://d3blocks.github.io/d3blocks/Radialgraph.html)   | ``` d3.radialgraph() ```     | [Radialgraph](https://medium.com/data-science-collective/radialgraph-a-new-way-to-explore-large-networks-without-the-hairball-ea34193ddec9)                              |
+|  3  | [Elasticgraph](https://d3blocks.github.io/d3blocks/elasticgraph.html)   | ``` d3.elasticgraph() ```    | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510)                             |
+|  4  | [Sankey](https://d3blocks.github.io/d3blocks/Sankey.html)               | ``` d3.sankey()  ```         | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510)                                   |
+|  5  | [Movingbubbles](https://d3blocks.github.io/d3blocks/MovingBubbles.html) | ``` d3.movingbubbles()  ```  | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510)    |
+|  6  | [Scatter](https://d3blocks.github.io/d3blocks/Scatter.html)             | ``` d3.scatter()  ```        | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510)       |
+|  7  | [Heatmap](https://d3blocks.github.io/d3blocks/Heatmap.html)             | ``` d3.heatmap()  ```        | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510)  |
+|  8  | [Chord diagram](https://d3blocks.github.io/d3blocks/Chord.html)         | ``` d3.chord()  ```          | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  9  | [Timeseries](https://d3blocks.github.io/d3blocks/Timeseries.html)       | ``` d3.timeseries()  ```     | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  10 | [Image slider](https://d3blocks.github.io/d3blocks/Imageslider.html)    | ``` d3.imageslider()  ```    | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  11 | [Violin plot](https://d3blocks.github.io/d3blocks/Violin.html)          | ``` d3.violin()  ```         | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  12 | [Particles](https://d3blocks.github.io/d3blocks/Particles.html)         | ``` d3.particles()  ```      | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  13 | [Treemap](https://d3blocks.github.io/d3blocks/Treemap.html)             | ``` d3.treemap()  ```        | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  14 | [Tree](https://d3blocks.github.io/d3blocks/Tree.html)                   | ``` d3.tree()  ```           | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  15 | [Maps](https://d3blocks.github.io/d3blocks/Maps.html)                   | ``` d3.maps()  ```           | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  16 | [Circlepacking](https://d3blocks.github.io/d3blocks/Circlepacking.html) | ``` d3.circlepacking()  ```  | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  17 | [Flowgraph](https://d3blocks.github.io/d3blocks/Flowgraph.html)         | ``` d3.flowgraph()  ```      | [Dagre](https://github.com/dagrejs/dagre) |
+|  18 | [Sequence](https://d3blocks.github.io/d3blocks/Sequence.html)           | ``` d3.sequence()  ```       | [Mermaid sequenceDiagram](https://mermaid.js.org/syntax/sequenceDiagram.html) |
+|  19 | [ERD](https://d3blocks.github.io/d3blocks/ERD.html)                     | ``` d3.erd()  ```            | [Mermaid erDiagram](https://mermaid.js.org/syntax/entityRelationshipDiagram.html) |
+
+-------------------------------------------------------------------------
+
+#### Installation (Pypi)
+```bash
+pip install d3blocks     # Normal installation
+pip install -U d3blocks  # Force update
+```
+
+#### Clone
+```bash
+# Clone only the latest branch to avoid downloading large history.
+git config --global clone.depth 1
+```
+
+
+
+#### Installation (from GitHub source)
+```bash
+pip install git+https://github.com/d3blocks/d3blocks.git
+```
+
+##### Install skill:
+```bash
+# for visualizations
+npx skills add d3blocks/d3blocks --skill d3blocks
+
+# for chart builder
+npx skills add d3blocks/d3blocks --skill d3blocks-chart-builder
+
+# for docs diagrams (convert a repo's Mermaid diagrams)
+npx skills add d3blocks/d3blocks --skill d3blocks-docs-diagrams
+```
+
+
+#### Import d3blocks package
+```python
+from d3blocks import D3Blocks
+# Initialize
+d3 = D3Blocks()
+```
+
+
+---
+
+### D3Blocks💙Streamlit
+Every chart from D3Block can easily be incorporated into a Streamlit Dashboard. Because every D3Blocks chart is just HTML and JavaScript, you can generate the HTML in memory and embed it
+A few practical rules of thumb: prefer `st.iframe` over the older `components.html` for full interactive charts, always pass an explicit pixel height, and set `show_side_panel=False` when Streamlit already owns the controls so the UI doesn't duplicate. `color_background='streamlit'` picks backgrounds that match a typical Streamlit light or dark page.
+
+* [Minimal examples for each chart can be found in the Streamlit directory in the repo](https://github.com/d3blocks/d3blocks/tree/main/streamlit).
+* [More Streamlit documentation can be found here.](https://d3blocks.github.io/d3blocks/Streamlit.html)
+
+---
+
+### Ethical Ads
+When HTMLs are generated, it automatically includes ethical ads as a small way to support development.
+I maintain this entire project thoughtfully and in my free time. Ads can be disabled via an input parameter, and you can also support the project with a coffee donation instead.
+
+### Star history
+[![Star History Chart](https://star-history.dera.page/svg?repos=d3blocks/d3blocks)](https://star-history.dera.page/d3blocks/d3blocks)
+
+### References
+* [bl.ocks](https://bl.ocks.org/)
+* [observablehq](https://observablehq.com/top)
+
+### Contributors
+
+<p align="left">
+  <a href="https://github.com/d3blocks/d3blocks/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=d3blocks/d3blocks" />
+  </a>
+</p>
+
+### Maintainer
+* Erdogan Taskesen, github: [erdogant](https://github.com/erdogant)
+* Contributions are welcome.
+* Yes! This library is entirely **free** but it runs on coffee! :) Feel free to support with a <a href="https://erdogant.github.io/donate/?currency=USD&amount=5">Coffee</a>.
+
+[![Buy me a coffee](https://img.buymeacoffee.com/button-api/?text=Buy+me+a+coffee&emoji=&slug=erdogant&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=FFDD00)](https://www.buymeacoffee.com/erdogant)

d3blocks-2.3.0/README.md

@@ -0,0 +1,150 @@
+[![Python](https://img.shields.io/pypi/pyversions/d3blocks)](https://img.shields.io/pypi/pyversions/d3blocks)
+[![Pypi](https://img.shields.io/pypi/v/d3blocks)](https://pypi.org/project/d3blocks/)
+[![Docs](https://img.shields.io/badge/Sphinx-Docs-blue)](https://d3blocks.github.io/d3blocks/)
+[![LOC](https://sloc.xyz/github/d3blocks/d3blocks/?category=code)](https://github.com/d3blocks/d3blocks/)
+[![Downloads](https://static.pepy.tech/personalized-badge/d3blocks?period=month&units=international_system&left_color=grey&right_color=brightgreen&left_text=PyPI%20downloads/month)](https://pepy.tech/project/d3blocks)
+[![Downloads](https://static.pepy.tech/personalized-badge/d3blocks?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads)](https://pepy.tech/project/d3blocks)
+[![License](https://img.shields.io/badge/license-GPL3-green.svg)](https://github.com/d3blocks/d3blocks/blob/master/LICENSE)
+[![Forks](https://img.shields.io/github/forks/d3blocks/d3blocks.svg)](https://github.com/d3blocks/d3blocks/network)
+[![Open Issues](https://img.shields.io/github/issues/d3blocks/d3blocks.svg)](https://github.com/d3blocks/d3blocks/issues)
+[![Project Status](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
+[![Medium](https://img.shields.io/badge/Medium-Blog-black)](https://d3blocks.github.io/d3blocks/Documentation.html#medium-blog)
+![GitHub Repo stars](https://img.shields.io/github/stars/d3blocks/d3blocks)
+![GitHub repo size](https://img.shields.io/github/repo-size/d3blocks/d3blocks)
+[![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://github.com/d3blocks/d3blocks/blob/main/notebooks/d3blocks.ipynb)
+[![Donate](https://img.shields.io/badge/Support%20this%20project-grey.svg?logo=github%20sponsors)](https://d3blocks.github.io/d3blocks/Documentation.html#)
+[![skills.sh](https://skills.sh/b/d3blocks/d3blocks)](https://skills.sh/d3blocks/d3blocks)
+
+###
+
+<div>
+
+<a href="https://d3blocks.github.io/d3blocks/"><img src="https://github.com/d3blocks/d3blocks/blob/main/logo.png" width="275" align="left" /></a>
+``D3Blocks`` is a Python package that builds on the graphics of d3 javascript (d3js). It allows you to create the most visually attractive and useful charts with only a few lines of Python code!
+The [documentation pages](https://d3blocks.github.io/d3blocks/) contain detailed information about the working of the blocks with many examples. **⭐️ Star it if you like it ⭐️**
+</div>
+
+---
+
+<p align="center">
+  <a href="https://d3blocks.github.io/d3blocks">
+  <img src="https://github.com/d3blocks/d3blocks/blob/main/docs/figs/summary.png" width="600" />
+  </a>
+</p>
+
+---
+
+### Resources and Links
+- [**Example Notebooks**](https://d3blocks.github.io/d3blocks/Documentation.html#google-colab-notebooks)
+- [**Documentation**](https://d3blocks.github.io/d3blocks)
+- [**Bug Reports and Feature Requests**](https://github.com/d3blocks/d3blocks/issues)
+
+### Blogs
+- [**Medium Blog**](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510)
+- [**Substack with podcast**](https://erdogant.substack.com/p/d3blocks-the-python-library-to-create)
+- [**Gumroad Blogs with podcast**](https://erdogant.gumroad.com/l/d3blocks-the-python-library-to-create-interactive-standalone-and-beautiful-d3-js-charts)
+
+-------------------------------------------------------------------------
+### [Available charts](https://d3blocks.github.io/d3blocks/)
+
+
+|  nr |  Block                                                                             |    Function                  |    More Information                                                                 |
+|-----|------------------------------------------------------------------------------------|------------------------------|-------------------------------------------------------------------------|
+|  1  | [D3graph](https://d3blocks.github.io/d3blocks/d3graph.html)                | ``` d3.d3graph() ```         | [D3graph](https://medium.com/data-science-collective/how-to-turn-any-network-into-an-interactive-knowledge-graph-to-discover-hidden-insights-f49fae4757ff)                                  |
+|  2  | [Radialgraph](https://d3blocks.github.io/d3blocks/Radialgraph.html)   | ``` d3.radialgraph() ```     | [Radialgraph](https://medium.com/data-science-collective/radialgraph-a-new-way-to-explore-large-networks-without-the-hairball-ea34193ddec9)                              |
+|  3  | [Elasticgraph](https://d3blocks.github.io/d3blocks/elasticgraph.html)   | ``` d3.elasticgraph() ```    | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510)                             |
+|  4  | [Sankey](https://d3blocks.github.io/d3blocks/Sankey.html)               | ``` d3.sankey()  ```         | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510)                                   |
+|  5  | [Movingbubbles](https://d3blocks.github.io/d3blocks/MovingBubbles.html) | ``` d3.movingbubbles()  ```  | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510)    |
+|  6  | [Scatter](https://d3blocks.github.io/d3blocks/Scatter.html)             | ``` d3.scatter()  ```        | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510)       |
+|  7  | [Heatmap](https://d3blocks.github.io/d3blocks/Heatmap.html)             | ``` d3.heatmap()  ```        | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510)  |
+|  8  | [Chord diagram](https://d3blocks.github.io/d3blocks/Chord.html)         | ``` d3.chord()  ```          | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  9  | [Timeseries](https://d3blocks.github.io/d3blocks/Timeseries.html)       | ``` d3.timeseries()  ```     | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  10 | [Image slider](https://d3blocks.github.io/d3blocks/Imageslider.html)    | ``` d3.imageslider()  ```    | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  11 | [Violin plot](https://d3blocks.github.io/d3blocks/Violin.html)          | ``` d3.violin()  ```         | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  12 | [Particles](https://d3blocks.github.io/d3blocks/Particles.html)         | ``` d3.particles()  ```      | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  13 | [Treemap](https://d3blocks.github.io/d3blocks/Treemap.html)             | ``` d3.treemap()  ```        | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  14 | [Tree](https://d3blocks.github.io/d3blocks/Tree.html)                   | ``` d3.tree()  ```           | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  15 | [Maps](https://d3blocks.github.io/d3blocks/Maps.html)                   | ``` d3.maps()  ```           | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  16 | [Circlepacking](https://d3blocks.github.io/d3blocks/Circlepacking.html) | ``` d3.circlepacking()  ```  | [D3Blocks](https://medium.com/data-science-collective/d3blocks-the-sweet-spot-for-data-scientists-interactive-charts-without-deployment-friction-c7f576025510) |
+|  17 | [Flowgraph](https://d3blocks.github.io/d3blocks/Flowgraph.html)         | ``` d3.flowgraph()  ```      | [Dagre](https://github.com/dagrejs/dagre) |
+|  18 | [Sequence](https://d3blocks.github.io/d3blocks/Sequence.html)           | ``` d3.sequence()  ```       | [Mermaid sequenceDiagram](https://mermaid.js.org/syntax/sequenceDiagram.html) |
+|  19 | [ERD](https://d3blocks.github.io/d3blocks/ERD.html)                     | ``` d3.erd()  ```            | [Mermaid erDiagram](https://mermaid.js.org/syntax/entityRelationshipDiagram.html) |
+
+-------------------------------------------------------------------------
+
+#### Installation (Pypi)
+```bash
+pip install d3blocks     # Normal installation
+pip install -U d3blocks  # Force update
+```
+
+#### Clone
+```bash
+# Clone only the latest branch to avoid downloading large history.
+git config --global clone.depth 1
+```
+
+
+
+#### Installation (from GitHub source)
+```bash
+pip install git+https://github.com/d3blocks/d3blocks.git
+```
+
+##### Install skill:
+```bash
+# for visualizations
+npx skills add d3blocks/d3blocks --skill d3blocks
+
+# for chart builder
+npx skills add d3blocks/d3blocks --skill d3blocks-chart-builder
+
+# for docs diagrams (convert a repo's Mermaid diagrams)
+npx skills add d3blocks/d3blocks --skill d3blocks-docs-diagrams
+```
+
+
+#### Import d3blocks package
+```python
+from d3blocks import D3Blocks
+# Initialize
+d3 = D3Blocks()
+```
+
+
+---
+
+### D3Blocks💙Streamlit
+Every chart from D3Block can easily be incorporated into a Streamlit Dashboard. Because every D3Blocks chart is just HTML and JavaScript, you can generate the HTML in memory and embed it
+A few practical rules of thumb: prefer `st.iframe` over the older `components.html` for full interactive charts, always pass an explicit pixel height, and set `show_side_panel=False` when Streamlit already owns the controls so the UI doesn't duplicate. `color_background='streamlit'` picks backgrounds that match a typical Streamlit light or dark page.
+
+* [Minimal examples for each chart can be found in the Streamlit directory in the repo](https://github.com/d3blocks/d3blocks/tree/main/streamlit).
+* [More Streamlit documentation can be found here.](https://d3blocks.github.io/d3blocks/Streamlit.html)
+
+---
+
+### Ethical Ads
+When HTMLs are generated, it automatically includes ethical ads as a small way to support development.
+I maintain this entire project thoughtfully and in my free time. Ads can be disabled via an input parameter, and you can also support the project with a coffee donation instead.
+
+### Star history
+[![Star History Chart](https://star-history.dera.page/svg?repos=d3blocks/d3blocks)](https://star-history.dera.page/d3blocks/d3blocks)
+
+### References
+* [bl.ocks](https://bl.ocks.org/)
+* [observablehq](https://observablehq.com/top)
+
+### Contributors
+
+<p align="left">
+  <a href="https://github.com/d3blocks/d3blocks/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=d3blocks/d3blocks" />
+  </a>
+</p>
+
+### Maintainer
+* Erdogan Taskesen, github: [erdogant](https://github.com/erdogant)
+* Contributions are welcome.
+* Yes! This library is entirely **free** but it runs on coffee! :) Feel free to support with a <a href="https://erdogant.github.io/donate/?currency=USD&amount=5">Coffee</a>.
+
+[![Buy me a coffee](https://img.buymeacoffee.com/button-api/?text=Buy+me+a+coffee&emoji=&slug=erdogant&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=FFDD00)](https://www.buymeacoffee.com/erdogant)

{d3blocks-2.2.0 → d3blocks-2.3.0}/d3blocks/__init__.py

@@ -10,7 +10,7 @@ from d3blocks.utils import (
 
 __author__ = 'Erdogan Taskesen'
 __email__ = 'erdogant@gmail.com'
-__version__ = '2.2.0'
+__version__ = '2.3.0'
 
 # Setup root logger
 import logging

d3blocks-2.3.0/d3blocks/_shared/__init__.py

@@ -0,0 +1,208 @@
+"""Code shared by the flowgraph, sequence and erd blocks.
+
+* template_env(): a Jinja environment over a block's own d3js/ folder and
+  d3blocks/_shared/d3js/ (walkthrough.js/.css, theme.js and the d3.v7.min.js
+  used by sequence and erd), so a template can {% include %} both and the
+  output stays self-contained.
+* notebook_iframe(): the Jupyter iframe wrapper.
+* dark_mode_flag(): validates dark_mode (True, False or 'auto').
+* normalize_steps(): validates the captioned walkthrough steps.
+
+Library     : d3blocks
+Github      : https://github.com/d3blocks/d3blocks
+License     : GPL3
+"""
+
+from html import escape as html_escape
+from pathlib import Path
+
+import numpy as np
+from jinja2 import ChoiceLoader, Environment, FileSystemLoader, PackageLoader
+
+DARK_MODES = (True, False, "auto")
+STEP_KEYS = ("title", "caption", "highlight")
+
+
+def template_env(package_name, block_file):
+    """Jinja environment over the block's d3js/ folder, then _shared/d3js/.
+
+    Parameters
+    ----------
+    package_name : str
+        __name__ of the block module, e.g. 'd3blocks.sequence.Sequence'.
+    block_file : str
+        __file__ of the block module (used when the package loader is unavailable).
+    """
+
+    def loader(package, folder):
+        try:
+            return PackageLoader(package_name=package, package_path="d3js")
+        except Exception:
+            return FileSystemLoader(str(Path(folder).resolve().parent / "d3js"))
+
+    return Environment(
+        loader=ChoiceLoader(
+            [loader(package_name, block_file), loader(__name__, __file__)]
+        )
+    )
+
+
+def notebook_iframe(html, config, block):
+    """Wrap a chart page in an iframe for Jupyter.
+
+    The page fills its window (fixed positioning, own body background) and uses
+    fixed element ids, so it is isolated in an iframe instead of being injected
+    into the notebook page. Size: figsize, else full width x 650 px.
+    """
+    width, height = (list(config.get("figsize") or [None, None]) + [None, None])[:2]
+    width = "%dpx" % width if width else "100%"
+    height = "%dpx" % height if height else "650px"
+    # Wrapped in a div: IPython warns about HTML that starts with '<iframe'.
+    return (
+        '<div class="d3blocks-%s"><iframe srcdoc="%s" title="%s" '
+        'style="width:%s;height:%s;border:0;border-radius:6px" '
+        'sandbox="allow-scripts allow-downloads allow-popups"></iframe></div>'
+        % (
+            block,
+            html_escape(html, quote=True),
+            html_escape(str(config.get("title", block))),
+            width,
+            height,
+        )
+    )
+
+
+def dark_mode_flag(dark_mode):
+    """Template flag for dark_mode: 'true', 'false' or 'auto'.
+
+    * True: dark theme.
+    * False: light theme.
+    * 'auto': follow the operating system theme until the viewer uses the theme toggle.
+    """
+    if isinstance(dark_mode, (bool, np.bool_)):
+        return "true" if dark_mode else "false"
+    if isinstance(dark_mode, str) and dark_mode.lower() == "auto":
+        return "auto"
+    raise ValueError("dark_mode must be True, False or 'auto'; got %r." % (dark_mode,))
+
+
+def check_dark_mode(dark_mode):
+    """dark_mode as True, False or 'auto'; raises ValueError for anything else."""
+    flag = dark_mode_flag(dark_mode)
+    return "auto" if flag == "auto" else flag == "true"
+
+
+def normalize_steps(steps, refs, block):
+    """Validate walkthrough steps and return them as JSON-ready dicts.
+
+    Parameters
+    ----------
+    steps : list of dict or None
+        [{'title': str, 'caption': str, 'highlight': {key: [ref, ...]}}]
+    refs : dict
+        {highlight key: check(ref, step_index) -> resolved ref}. Only these
+        highlight keys are accepted; a check raises ValueError for an unknown ref.
+    block : str
+        Block name, used in error messages.
+
+    Returns
+    -------
+    list of dict or None
+        [{'title', 'caption', 'highlight'}], or None when steps is None.
+
+    """
+    if steps is None:
+        return None
+    if isinstance(steps, (str, dict)) or not hasattr(steps, "__iter__"):
+        raise ValueError(
+            "steps must be a list of dicts or None; got %s." % type(steps).__name__
+        )
+    out = []
+    for i, step in enumerate(steps):
+        if not isinstance(step, dict):
+            raise ValueError(
+                "steps[%d]: expected a dict with %s; got %s."
+                % (i, STEP_KEYS, type(step).__name__)
+            )
+        unknown = sorted(set(step) - set(STEP_KEYS))
+        if unknown:
+            raise ValueError(
+                "steps[%d]: unknown key(s) %s; use %s." % (i, unknown, STEP_KEYS)
+            )
+        highlight = step.get("highlight") or {}
+        if not isinstance(highlight, dict):
+            raise ValueError(
+                "steps[%d]: 'highlight' must be a dict; got %s."
+                % (i, type(highlight).__name__)
+            )
+        unsupported = sorted(set(highlight) - set(refs))
+        if unsupported:
+            raise ValueError(
+                "steps[%d]: highlight key(s) %s are not supported by %s; use %s."
+                % (i, unsupported, block, tuple(refs))
+            )
+        resolved = {}
+        for key, values in highlight.items():
+            if values is None:
+                continue
+            if isinstance(values, (str, int, np.integer)):
+                values = [values]
+            resolved[key] = [refs[key](v, i) for v in values]
+        out.append(
+            {
+                "title": str(step.get("title") or "Step %d" % (i + 1)),
+                "caption": str(step.get("caption") or ""),
+                "highlight": resolved,
+            }
+        )
+    return out
+
+
+def ref_in(names, what):
+    """Check for a reference that must be one of `names`."""
+    names = set(names)
+
+    def check(ref, i):
+        key = str(ref)
+        if key not in names:
+            raise ValueError("steps[%d]: unknown %s %r." % (i, what, ref))
+        return key
+
+    return check
+
+
+def pair_in(pairs, what, undirected=False):
+    """Check for a (source, target) reference that must be in `pairs`."""
+    pairs = {(str(s), str(t)) for s, t in pairs}
+
+    def check(ref, i):
+        if isinstance(ref, str) or not hasattr(ref, "__len__") or len(ref) != 2:
+            raise ValueError(
+                "steps[%d]: %s must be (source, target) pairs; got %r." % (i, what, ref)
+            )
+        s, t = str(ref[0]), str(ref[1])
+        if (s, t) in pairs:
+            return [s, t]
+        if undirected and (t, s) in pairs:
+            return [t, s]
+        raise ValueError("steps[%d]: unknown %s %r." % (i, what, tuple(ref)))
+
+    return check
+
+
+def index_in(count, what):
+    """Check for an integer index in range(count)."""
+
+    def check(ref, i):
+        if (
+            isinstance(ref, (bool, np.bool_))
+            or not isinstance(ref, (int, np.integer))
+            or not 0 <= ref < count
+        ):
+            raise ValueError(
+                "steps[%d]: unknown %s %r; use an index from 0 to %d."
+                % (i, what, ref, count - 1)
+            )
+        return int(ref)
+
+    return check

d3blocks-2.3.0/d3blocks/_shared/d3js/theme.js

@@ -0,0 +1,63 @@
+/*
+ * theme.js - dark/light theme for d3blocks diagrams (flowgraph, sequence, erd).
+ * Included right after <body data-dark-mode="true|false|auto">, so the first
+ * paint already has the right theme. 'auto' follows the operating system
+ * (prefers-color-scheme) until the viewer presses the theme toggle; a
+ * ?theme=light|dark URL parameter overrides 'auto', as in archify.
+ */
+window.D3BlocksTheme = (function () {
+  'use strict';
+  var body = document.body;
+  var mode = body.getAttribute('data-dark-mode') || 'true';
+  var followOs = mode === 'auto';
+  var media = null;
+
+  function isLight() { return body.classList.contains('light'); }
+
+  function syncButton(btn) {
+    if (!btn) return;
+    var light = isLight();
+    btn.textContent = light ? '☀' : '🌙';
+    btn.title = light ? 'Theme: Light' : 'Theme: Dark';
+    btn.setAttribute('aria-pressed', light ? 'true' : 'false');
+  }
+
+  var buttons = [];
+  function set(light) {
+    body.classList.toggle('light', !!light);
+    buttons.forEach(syncButton);
+  }
+
+  if (followOs) {
+    var param = null;
+    try { param = new URLSearchParams(window.location.search).get('theme'); } catch (e) { /* no URL */ }
+    if (param === 'light' || param === 'dark') {
+      followOs = false;
+      set(param === 'light');
+    } else if (window.matchMedia) {
+      // No OS preference (or no matchMedia) falls back to dark.
+      media = window.matchMedia('(prefers-color-scheme: light)');
+      set(media.matches);
+      var onChange = function (e) { if (followOs) set(e.matches); };
+      if (media.addEventListener) media.addEventListener('change', onChange);
+      else if (media.addListener) media.addListener(onChange);
+    } else {
+      set(false);
+    }
+  }
+
+  return {
+    isLight: isLight,
+    // Wire a toggle button; after the first press the toggle wins over the OS theme.
+    bind: function (id) {
+      var btn = document.getElementById(id);
+      if (!btn) return;
+      buttons.push(btn);
+      syncButton(btn);
+      btn.addEventListener('click', function () {
+        followOs = false;
+        set(!isLight());
+      });
+    }
+  };
+})();