legendkit 0.3.2__tar.gz → 0.3.4__tar.gz

legendkit-0.3.4/.github/workflows/build.yaml

@@ -0,0 +1,57 @@
+name: Build
+
+on: [push, pull_request]
+
+jobs:
+  Test_Installation:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[dev]
+      - name: Test with pytest
+        run: |
+          pip install pytest
+          pip install pytest-cov
+          pytest --cov=marsilea/ --cov-report=xml tests/
+
+  Upload_to_test_pypi:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flit
+          pip install .
+
+      - name: Publish to test.ipynb pypi
+        env:
+          FLIT_INDEX_URL: https://test.ipynb.pypi.org/legacy/
+          FLIT_USERNAME: __token__
+          FLIT_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: flit publish || exit 0
+
+      - name: Publish to pypi
+        if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v')
+        env:
+          FLIT_INDEX_URL: https://upload.pypi.org/legacy/
+          FLIT_USERNAME: __token__
+          FLIT_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: flit publish

legendkit-0.3.4/.gitignore

@@ -0,0 +1,163 @@
+# 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/#use-with-ide
+.pdm.toml
+
+# 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/
+notebooks/
+
+.DS_Store

legendkit-0.3.4/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Mr-Milk
+
+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.

{legendkit-0.3.2 → legendkit-0.3.4}/PKG-INFO

@@ -1,25 +1,29 @@
 Metadata-Version: 2.1
 Name: legendkit
-Version: 0.3.2
+Version: 0.3.4
 Summary: Legend creation and manipulation with ease for matplotlib
-Home-page: https://github.com/Heatgraphy/legendkit
-License: MIT
-Author: Mr-Milk
-Author-email: yb97643@um.edu.mo
-Requires-Python: >=3.8,<4.0
-Classifier: Framework :: Matplotlib
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Science/Research
+Author-email: Mr-Milk <yzheng@cemm.at>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3
+Classifier: Framework :: Matplotlib
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
 Classifier: Topic :: Scientific/Engineering :: Visualization
-Requires-Dist: matplotlib (>=3.6,<4.0)
-Project-URL: Repository, https://github.com/Heatgraphy/legendkit
-Description-Content-Type: text/markdown
+Requires-Dist: matplotlib
+Requires-Dist: ruff ; extra == "dev"
+Requires-Dist: icecream ; extra == "dev"
+Requires-Dist: python-hmr ; extra == "dev"
+Requires-Dist: pytest ; extra == "dev"
+Requires-Dist: scikit-learn ; extra == "dev"
+Requires-Dist: sphinx ; extra == "dev"
+Requires-Dist: numpydoc ; extra == "dev"
+Requires-Dist: sphinx_gallery ; extra == "dev"
+Requires-Dist: furo ; extra == "dev"
+Requires-Dist: mpl_fontkit ; extra == "dev"
+Project-URL: Home, https://github.com/Marsilea-viz/legendkit
+Provides-Extra: dev
 
 <p align="center">
 <img src="https://raw.githubusercontent.com/Mr-Milk/legendkit/main/images/legendkit-project.svg">
@@ -31,7 +35,7 @@ Description-Content-Type: text/markdown
 When you want to create or adjust the legend in matplotlib, things can get dirty. 
 Legendkit may solve your headache.
 
-<img src="https://legendkit.readthedocs.io/en/latest/_images/cover.svg">
+<img src="https://legendkit.readthedocs.io/en/latest/_images/cover.png">
 
 ## Features
 

{legendkit-0.3.2 → legendkit-0.3.4}/README.md

@@ -8,7 +8,7 @@
 When you want to create or adjust the legend in matplotlib, things can get dirty. 
 Legendkit may solve your headache.
 
-<img src="https://legendkit.readthedocs.io/en/latest/_images/cover.svg">
+<img src="https://legendkit.readthedocs.io/en/latest/_images/cover.png">
 
 ## Features
 

legendkit-0.3.4/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

legendkit-0.3.4/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

legendkit-0.3.4/docs/requirements.txt

@@ -0,0 +1,7 @@
+Sphinx==6.1.3
+furo==2022.12.7
+matplotlib==3.5.3
+scipy==1.10.0
+pandas==1.5.0
+numpydoc==1.4.0
+mpl_fontkit

legendkit-0.3.4/docs/source/.gitignore

@@ -0,0 +1 @@
+API/

legendkit-0.3.4/docs/source/_templates/autosummary/class.rst

@@ -0,0 +1,12 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+
+   {% block methods %}
+
+   {% if methods %}
+
+   {% endif %}
+   {% endblock %}

legendkit-0.3.4/docs/source/api.rst

@@ -0,0 +1,16 @@
+.. currentmodule:: legendkit
+
+API Reference
+================
+
+.. autosummary::
+   :toctree: API
+
+    legend
+    cat_legend
+    size_legend
+    colorbar
+    colorart
+    vstack
+    hstack
+    handles

legendkit-0.3.4/docs/source/conf.py

@@ -0,0 +1,88 @@
+from cycler import cycler
+import legendkit
+
+project = 'legendkit'
+copyright = '2024, Mr-Milk'
+author = 'Mr-Milk'
+release = legendkit.__version__
+
+extensions = [
+    'numpydoc',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.autosectionlabel',
+    'matplotlib.sphinxext.plot_directive',
+    'sphinx.ext.intersphinx',
+]
+
+# Make sure the target is unique
+autosectionlabel_prefix_document = True
+
+# setting autosummary
+autosummary_generate = True
+autoclass_content = "class"
+numpydoc_show_class_members = False
+
+# setting plot directive
+plot_include_source = True
+plot_html_show_source_link = False
+plot_html_show_formats = False
+plot_formats = [('png', 200)]
+plot_rcparams = {'savefig.bbox': 'tight',
+                 'font.family': 'Lato',
+                 'xtick.color': '.15',
+                 'ytick.color': '.15',
+                 'axes.axisbelow': True,
+                 'grid.linestyle': '-',
+                 'lines.solid_capstyle': 'round',
+                 'axes.grid': True,
+                 'axes.facecolor': 'EAEAF2',
+                 'axes.edgecolor': 'white',
+                 'axes.linewidth': 0,
+                 'grid.color': 'white',
+                 'xtick.major.size': 0,
+                 'ytick.major.size': 0,
+                 'xtick.minor.size': 0,
+                 'ytick.minor.size': 0,
+                 'axes.prop_cycle': cycler('color',
+                                           ['#5A5B9F', '#D94F70', '#009473',
+                                            '#F0C05A', '#7BC4C4', '#FF6F61']),
+                 'legend.borderpad': 0.,
+                 'legend.labelspacing': 0.5,
+                 'legend.handlelength': 1.0,
+                 'legend.handleheight': 1.0,
+                 'legend.handletextpad': 0.5,
+                 'legend.borderaxespad': 0.5,
+                 'legend.columnspacing': 1.0
+                 }
+plot_apply_rcparams = True
+plot_pre_code = """
+import numpy as np
+from matplotlib import pyplot as plt
+import mpl_fontkit as fk
+
+fk.install("Lato")
+np.random.seed(0)
+
+"""
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+html_theme = 'furo'
+html_static_path = ['_static']
+html_favicon = "../../images/legendkit-logo.svg"
+
+intersphinx_mapping = {
+    'matplotlib': ('https://matplotlib.org/stable', None),
+}
+
+
+def setup(app):
+    import legendkit as lk
+    # Trick sphinx that these APIs are not alias
+    lk.legend.__name__ = "legend"
+    lk.cat_legend.__name__ = "cat_legend"
+    lk.size_legend.__name__ = "size_legend"
+    lk.colorbar.__name__ = "colorbar"
+    lk.colorart.__name__ = "colorart"

legendkit-0.3.4/docs/source/cover.py

@@ -0,0 +1,95 @@
+import matplotlib as mpl
+import matplotlib.pyplot as plt
+import numpy as np
+from matplotlib.colors import Normalize
+
+from legendkit import legend, cat_legend, colorbar, colorart, hstack, vstack, size_legend
+
+mpl.rcParams['legend.handleheight'] = 1
+mpl.rcParams['legend.handlelength'] = 1
+mpl.rcParams['legend.labelspacing'] = .3
+
+legend_items = [
+    ('square', 'L1', {'color': "#e76f51"}),
+    ('circle', 'L2', {'color': "#2a9d8f"}),
+    ('triangle', 'L3', {'color': "#e9c46a"}),
+]
+
+fig, ax = plt.subplots(figsize=(5.5, 6))
+legend1 = legend(legend_items=legend_items,
+                 title="Title Left",
+                 alignment="left")
+legend2 = legend(legend_items=legend_items,
+                 title="Title Center",
+                 alignment="center")
+legend3 = legend(legend_items=legend_items,
+                 title="Title Right",
+                 alignment="right")
+
+s1 = hstack([legend1, legend2, legend3], spacing=30,
+            title="Stack Horizontally")
+
+legend1 = legend(legend_items=legend_items, title="Title Top",
+                 title_loc="top", alignment="left")
+legend2 = legend(legend_items=legend_items, title="Title Bottom",
+                 title_loc="bottom", alignment="left")
+legend3 = legend(legend_items=legend_items, title="Title Right",
+                 title_loc="right", ncol=3)
+legend4 = legend(legend_items=legend_items, title="Title Left",
+                 title_loc="left", ncol=3)
+
+hs = hstack([legend1, legend2], spacing=30)
+vs = vstack([legend3, legend4], spacing=20)
+
+s2 = vstack([hs, vs],
+            spacing=20, align="center",
+            title="Stack Vertically")
+
+s3 = vstack([s1, s2], spacing=30, frameon=True, align="center",
+            loc="upper left",
+            title="Stack of Stacks of legends", ax=ax,
+            title_fontproperties={"fontsize": 14, "fontweight": 600,
+                                  "color": "#0089A7"})
+
+norm = Normalize(vmin=0, vmax=10)
+
+colorbar(ax=ax, norm=norm,
+         orientation="horizontal",
+         title="Colorbar", alignment="left",
+         loc="upper left", bbox_to_anchor=(1, 0.4),
+         bbox_transform=ax.transAxes)
+
+colorbar(ax=ax, norm=norm,
+         orientation="horizontal",
+         shape="ellipse", cmap="RdBu",
+         title="Ellipse Colorbar", alignment="left",
+         loc="upper left", bbox_to_anchor=(1, 0.2),
+         bbox_transform=ax.transAxes)
+
+colorbar(ax=ax, norm=norm,
+         orientation="horizontal",
+         shape="triangle", cmap="PuRd",
+         title="Triangle Colorbar", alignment="left",
+         loc="upper left", bbox_to_anchor=(1.4, 0.4),
+         bbox_transform=ax.transAxes)
+
+colorbar(ax=ax, norm=norm,
+         orientation="horizontal",
+         shape="trapezoid", cmap="coolwarm",
+         title="Trapezoid Colorbar", alignment="left",
+         loc="upper left", bbox_to_anchor=(1.4, 0.2),
+         bbox_transform=ax.transAxes)
+
+args = dict(
+    colors=["#A7D2CB", "#F2D388", "#A7D2CB", "#F2D388"],
+    labels=["Item 1", "Item 2", "Item 3", "Item 4"],
+)
+legend1 = cat_legend(**args, title="Category", handle="circle")
+legend2 = size_legend(sizes=np.arange(1, 401), title="Size", handle="circle")
+cart = colorart(norm=norm, cmap="cool", ax=ax, title="Colorart")
+hstack([legend1, legend2, cart], spacing=20, title="Stack colorbar and legend",
+       alignment="left",
+       loc="upper left", bbox_to_anchor=(1, 1), bbox_transform=ax.transAxes,
+       frameon=True, ax=ax, padding=2)
+
+ax.set_axis_off()

legendkit-0.3.4/docs/source/index.rst

@@ -0,0 +1,43 @@
+.. legendkit documentation master file, created by
+   sphinx-quickstart on Tue Aug 30 10:48:31 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Legendkit: Legend made easy for matplotlib
+==========================================
+
+.. image:: https://raw.githubusercontent.com/Mr-Milk/legendkit/main/images/legendkit-project.svg
+
+When you want to create or adjust the legend in matplotlib,
+things can get dirty.
+Legendkit may solve your headache.
+
+.. plot:: cover.py
+   :include-source: false
+
+
+Installation
+------------
+
+.. code-block:: shell
+
+   pip install legendkit
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Tutorial
+   :hidden:
+
+   tutorial/legend
+   tutorial/title&layout
+   tutorial/colorbar
+   tutorial/layout
+   tutorial/matplotlib_legend
+
+.. toctree::
+   :maxdepth: 1
+   :caption: API
+   :hidden:
+
+   api.rst

legendkit-0.3.4/docs/source/styles.mplstyle

@@ -0,0 +1,33 @@
+text.color: .15
+axes.labelcolor: .15
+legend.frameon: False
+legend.numpoints: 1
+legend.scatterpoints: 1
+xtick.direction: out
+ytick.direction: out
+xtick.color: .15
+ytick.color: .15
+axes.axisbelow: True
+font.family: sans-serif
+grid.linestyle: -
+lines.solid_capstyle: round
+
+# Seaborn darkgrid parameters
+axes.grid: True
+axes.facecolor: EAEAF2
+axes.edgecolor: white
+axes.linewidth: 0
+grid.color: white
+xtick.major.size: 0
+ytick.major.size: 0
+xtick.minor.size: 0
+ytick.minor.size: 0
+
+# Custom
+axes.prop_cycle: cycler('color', ['7A76C2', 'ff6e9c98', 'f62196', '18c0c4', 'f3907e', '66E9EC'])
+image.cmap: RdPu
+
+figure.facecolor: fefeff
+savefig.facecolor: fefeff
+savefig.bbox: tight
+