matplotlib-sankey 0.2.1__tar.gz

matplotlib_sankey-0.2.1/.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.{yml,yaml,toml},.cruft.json}]
+indent_size = 2
+
+[Makefile]
+indent_style = tab

matplotlib_sankey-0.2.1/.gitignore

@@ -0,0 +1,164 @@
+/docs/coverage_report
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

matplotlib_sankey-0.2.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 harryhaller001
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

matplotlib_sankey-0.2.1/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: matplotlib-sankey
+Version: 0.2.1
+Summary: Sankey plot for matplotlib
+Author: harryhaller001
+Maintainer-email: harryhaller001 <harryhaller001@gmail.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Matplotlib
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+License-File: LICENSE
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: ipykernel ; extra == "docs"
+Requires-Dist: ipython ; extra == "docs"
+Requires-Dist: ipywidgets ; extra == "docs"
+Requires-Dist: myst-parser ; extra == "docs"
+Requires-Dist: nbsphinx ; extra == "docs"
+Requires-Dist: networkx[default] ; extra == "docs"
+Requires-Dist: sphinx>=4 ; extra == "docs"
+Requires-Dist: sphinx-autoapi ; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints ; extra == "docs"
+Requires-Dist: sphinx-book-theme>=1 ; extra == "docs"
+Requires-Dist: coverage ; extra == "test"
+Requires-Dist: flit ; extra == "test"
+Requires-Dist: mypy ; extra == "test"
+Requires-Dist: pre-commit ; extra == "test"
+Requires-Dist: pytest ; extra == "test"
+Requires-Dist: ruff ; extra == "test"
+Requires-Dist: setuptools ; extra == "test"
+Requires-Dist: twine>=4.0.2 ; extra == "test"
+Project-URL: Documentation, https://github.com/harryhaller001/matplotlib-sankey
+Project-URL: Homepage, https://github.com/harryhaller001/matplotlib-sankey
+Project-URL: Source, https://github.com/harryhaller001/matplotlib-sankey
+Provides-Extra: docs
+Provides-Extra: test
+
+# matplotlib-sankey
+
+Sankey plot for matplotlib
+
+### Installation
+
+Install with pip:
+
+`pip install matplotlib-sankey`
+
+Install from source:
+
+```bash
+git clone https://github.com/harryhaller001/matplotlib-sankey
+cd matplotlib-sankey
+pip install .
+```
+
+
+### Example
+
+```python
+data = [
+    # (source index, target index, weight)
+    [(0, 2, 20), (0, 1, 10), (3, 4, 15), (3, 2, 10), (5, 1, 5), (5, 2, 50)],
+    [(2, 6, 40), (1, 6, 15), (2, 7, 40), (4, 6, 15)],
+    [(7, 8, 5), (7, 9, 5), (7, 10, 20), (7, 11, 10), (6, 11, 55), (6, 8, 15)],
+]
+
+fig, ax = plt.subplots(figsize=(10, 5))
+fig.tight_layout()
+sankey(
+    data=data,
+    cmap="tab20",
+    annotate_columns=True,
+    ax=ax,
+    spacing=0.03,
+)
+```
+
+![Sankey plot example](./docs/source/_static/images/example_sankey_plot.jpg)
+
+
+
+### Development
+
+```bash
+python3.10 -m virtualenv venv
+source venv/bin/activate
+
+# Install dev dependencies
+make install
+```
+

matplotlib_sankey-0.2.1/README.md

@@ -0,0 +1,53 @@
+# matplotlib-sankey
+
+Sankey plot for matplotlib
+
+### Installation
+
+Install with pip:
+
+`pip install matplotlib-sankey`
+
+Install from source:
+
+```bash
+git clone https://github.com/harryhaller001/matplotlib-sankey
+cd matplotlib-sankey
+pip install .
+```
+
+
+### Example
+
+```python
+data = [
+    # (source index, target index, weight)
+    [(0, 2, 20), (0, 1, 10), (3, 4, 15), (3, 2, 10), (5, 1, 5), (5, 2, 50)],
+    [(2, 6, 40), (1, 6, 15), (2, 7, 40), (4, 6, 15)],
+    [(7, 8, 5), (7, 9, 5), (7, 10, 20), (7, 11, 10), (6, 11, 55), (6, 8, 15)],
+]
+
+fig, ax = plt.subplots(figsize=(10, 5))
+fig.tight_layout()
+sankey(
+    data=data,
+    cmap="tab20",
+    annotate_columns=True,
+    ax=ax,
+    spacing=0.03,
+)
+```
+
+![Sankey plot example](./docs/source/_static/images/example_sankey_plot.jpg)
+
+
+
+### Development
+
+```bash
+python3.10 -m virtualenv venv
+source venv/bin/activate
+
+# Install dev dependencies
+make install
+```