Merge pull request #50 from nschloe/deprecate

Deprecate

Author: nschloe

README.md

@@ -1,3 +1,9 @@
+# Deprecation
+
+dufte as a stand-alone module has been deprecated and merged into [mplx](https://github.com/nschloe/mplx).
+
+---
+
 <p align="center">
   <a href="https://github.com/nschloe/dufte"><img alt="dufte-logo" src="https://nschloe.github.io/dufte/logo.svg" width="40%"></a>
   <p align="center"><a href="https://en.wikipedia.org/wiki/Berlin_German">Da kiekste, wa?</a></p>
@@ -7,7 +13,8 @@
 [![Anaconda Cloud](https://anaconda.org/conda-forge/dufte/badges/version.svg?=style=flat-square)](https://anaconda.org/conda-forge/dufte/)
 [![PyPI pyversions](https://img.shields.io/pypi/pyversions/dufte.svg?style=flat-square)](https://pypi.org/project/dufte/)
 [![GitHub stars](https://img.shields.io/github/stars/nschloe/dufte.svg?logo=github&label=Stars&logoColor=white&style=flat-square)](https://github.com/nschloe/dufte)
-[![PyPi downloads](https://img.shields.io/pypi/dm/dufte.svg?style=flat-square)](https://pypistats.org/packages/dufte)
+[![Downloads](https://pepy.tech/badge/dufte/month?style=flat-square)](https://pepy.tech/project/dufte)
+<!--[![PyPi downloads](https://img.shields.io/pypi/dm/dufte.svg?style=flat-square)](https://pypistats.org/packages/dufte)-->
 
 [![gh-actions](https://img.shields.io/github/workflow/status/nschloe/dufte/ci?style=flat-square)](https://github.com/nschloe/dufte/actions?query=workflow%3Aci)
 [![codecov](https://img.shields.io/codecov/c/github/nschloe/dufte.svg?style=flat-square)](https://codecov.io/gh/nschloe/dufte)
@@ -17,7 +24,13 @@
 This package creates clean and beautiful plots that work on light and dark backgrounds.
 Inspired by the work of [Edward Tufte](https://en.wikipedia.org/wiki/Edward_Tufte).
 
-To use, simply select the `dufte` style:
+To use, install with
+
+```
+pip install dufte
+```
+
+and simply select the `dufte` style:
 
 ```python
 import dufte
@@ -67,7 +80,7 @@ See [here](tests/create_comparison.py) for how to create the below plots.
 </table>
 </a>
 
-Further reading:
+### Further reading and other styles
 
 - [Remove to improve: data-ink ratio](https://www.darkhorseanalytics.com/blog/data-looks-better-naked)
 
@@ -79,6 +92,15 @@ Further reading:
 - [prettyplotlib](https://github.com/olgabot/prettyplotlib)
 - [Wikipedia: Chartjunk](https://en.wikipedia.org/wiki/Chartjunk)
 
+Other styles
+
+- [John Garrett, _Science Plots_](https://github.com/garrettj403/SciencePlots)
+- [Dominik Haitz, _Cyberpunk style_](https://github.com/dhaitz/mplcyberpunk)
+- [Dominik Haitz, _Matplotlib stylesheets_](https://github.com/dhaitz/matplotlib-stylesheets)
+- [Carlos da Costa, _The Grand Budapest Hotel_](https://github.com/cako/mpl_grandbudapest)
+- [Danny Antaki, _vaporwave aesthetics_](https://github.com/dantaki/vapeplot)
+- [QuantumBlack Labs, _QuantumBlack_](https://github.com/quantumblacklabs/qbstyles)
+
 Projects using dufte:
 
 - [perfplot](https://github.com/nschloe/perfplot)
@@ -100,20 +122,3 @@ non-negative least-squares problem
 
 where $`a`$ is the minimum distance between two entries and $`t_i`$ is the target
 position.
-
-### Testing
-
-To run the dufte unit tests, check out this repository and type
-
-```
-pytest
-```
-
-### Other style sheets and further reading
-
-- [John Garrett, _Science Plots_](https://github.com/garrettj403/SciencePlots)
-- [Dominik Haitz, _Cyberpunk style_](https://github.com/dhaitz/mplcyberpunk)
-- [Dominik Haitz, _Matplotlib stylesheets_](https://github.com/dhaitz/matplotlib-stylesheets)
-- [Carlos da Costa, _The Grand Budapest Hotel_](https://github.com/cako/mpl_grandbudapest)
-- [Danny Antaki, _vaporwave aesthetics_](https://github.com/dantaki/vapeplot)
-- [QuantumBlack Labs, _QuantumBlack_](https://github.com/quantumblacklabs/qbstyles)

justfile

@@ -7,7 +7,7 @@ default:
 
 tag:
 	@if [ "$(git rev-parse --abbrev-ref HEAD)" != "main" ]; then exit 1; fi
-	curl -H "Authorization: token `cat ~/.github-access-token`" -d '{"tag_name": "{{version}}"}' https://api.github.com/repos/nschloe/{{name}}/releases
+	curl -H "Authorization: token `cat ~/.github-access-token`" -d '{"tag_name": "v{{version}}"}' https://api.github.com/repos/nschloe/{{name}}/releases
 
 upload: clean
 	@if [ "$(git rev-parse --abbrev-ref HEAD)" != "main" ]; then exit 1; fi

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = dufte
-version = 0.2.28
+version = 0.2.29
 author = Nico Schlömer
 author_email = [email protected]
 description = Clean matplotlib plots

src/dufte/__init__.py

@@ -1,3 +1,10 @@
+import warnings
+
 from .main import legend, show_bar_values, style, style_bar, ylabel
 
 __all__ = ["legend", "style", "style_bar", "ylabel", "show_bar_values"]
+
+warnings.warn(
+    "dufte has been merged into mplx, <https://github.com/nschloe/mplx>",
+    DeprecationWarning,
+)