Merge pull request #306 from nschloe/python3-and-rename

Python3 and rename

Author: nschloe

.circleci/config.yml

@@ -9,8 +9,8 @@ jobs:
       - run: apt update
       - run: apt install -y python3-pip
       - run: pip3 install -U black flake8
-      - run: LC_ALL=C.UTF-8 black --check setup.py matplotlib2tikz/ test/*.py
-      - run: flake8 setup.py matplotlib2tikz/ test/*.py
+      - run: LC_ALL=C.UTF-8 black --check setup.py tikzplotlib/ test/*.py
+      - run: flake8 setup.py tikzplotlib/ test/*.py
   build:
     working_directory: ~/work
     docker:
@@ -28,7 +28,7 @@ jobs:
       - run: pip3 install .[all]
       - run: pip3 check
       # The actual test
-      - run: cd test/ && MPLBACKEND=Agg pytest --cov matplotlib2tikz
+      - run: cd test/ && MPLBACKEND=Agg pytest --cov tikzplotlib
       # submit to codecov
       - run: apt install -y curl
       - run: bash <(curl -s https://codecov.io/bash)

.travis.yml

@@ -52,11 +52,11 @@ before_script:
 
 # run tests
 script:
-  - pylint matplotlib2tikz/
+  - pylint tikzplotlib/
   - pylint test/*py
   # cd into test directory to make sure we're using the pip-installed
-  # matplotlib2tikz.
-  - cd test && MPLBACKEND=Agg pytest --cov matplotlib2tikz
+  # tikzplotlib.
+  - cd test && MPLBACKEND=Agg pytest --cov tikzplotlib
 
 after_success:
   - bash <(curl -s https://codecov.io/bash)

Makefile

@@ -1,4 +1,4 @@
-VERSION=$(shell python3 -c "import matplotlib2tikz; print(matplotlib2tikz.__version__)")
+VERSION=$(shell python3 -c "import tikzplotlib; print(tikzplotlib.__version__)")
 
 default:
 	@echo "\"make publish\"?"
@@ -23,9 +23,13 @@ clean:
 	@find . | grep -E "(__pycache__|\.pyc|\.pyo$\)" | xargs rm -rf
 	@rm -rf *.egg-info/ build/ dist/ MANIFEST
 
+format:
+	isort -rc .
+	black .
+
 black:
-	black setup.py matplotlib2tikz/ test/*.py
+	black .
 
 lint:
-	black --check setup.py matplotlib2tikz/ test/*.py
-	flake8 setup.py matplotlib2tikz/ test/*.py
+	black --check .
+	flake8 setup.py tikzplotlib/ test/*.py

README.md

@@ -1,27 +1,29 @@
-# matplotlib2tikz
-
-[![CircleCI](https://img.shields.io/circleci/project/github/nschloe/matplotlib2tikz/master.svg)](https://circleci.com/gh/nschloe/matplotlib2tikz/tree/master)
-[![codecov](https://img.shields.io/codecov/c/github/nschloe/matplotlib2tikz.svg)](https://codecov.io/gh/nschloe/matplotlib2tikz)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
-[![Documentation Status](https://readthedocs.org/projects/matplotlib2tikz/badge/?version=latest)](https://readthedocs.org/projects/matplotlib2tikz/?badge=latest)
-[![awesome](https://img.shields.io/badge/awesome-yes-brightgreen.svg)](https://github.com/nschloe/matplotlib2tikz)
-[![PyPi Version](https://img.shields.io/pypi/v/matplotlib2tikz.svg)](https://pypi.org/project/matplotlib2tikz)
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1173089.svg)](https://doi.org/10.5281/zenodo.1173089)
-[![GitHub stars](https://img.shields.io/github/stars/nschloe/matplotlib2tikz.svg?logo=github&label=Stars&logoColor=white)](https://github.com/nschloe/matplotlib2tikz)
-[![PyPi downloads](https://img.shields.io/pypi/dd/matplotlib2tikz.svg)](https://pypistats.org/packages/matplotlib2tikz)
-
-This is matplotlib2tikz, a Python tool for converting matplotlib figures into
+<p align="center">
+  <img alt="tikzplotlib" src="https://nschloe.github.io/tikzplotlib/logo-tikzplotlib.svg" width="60%">
+</p>
+
+[![CircleCI](https://img.shields.io/circleci/project/github/nschloe/tikzplotlib/master.svg?style=flat-square)](https://circleci.com/gh/nschloe/tikzplotlib/tree/master)
+[![codecov](https://img.shields.io/codecov/c/github/nschloe/tikzplotlib.svg?style=flat-square)](https://codecov.io/gh/nschloe/tikzplotlib)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/ambv/black)
+[![Documentation Status](https://readthedocs.org/projects/tikzplotlib/badge/?version=latest&style=flat-square)](https://readthedocs.org/projects/tikzplotlib/?badge=latest)
+[![awesome](https://img.shields.io/badge/awesome-yes-brightgreen.svg?style=flat-square)](https://github.com/nschloe/tikzplotlib)
+[![PyPi Version](https://img.shields.io/pypi/v/tikzplotlib.svg?style=flat-square)](https://pypi.org/project/tikzplotlib)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1173089.svg?style=flat-square)](https://doi.org/10.5281/zenodo.1173089)
+[![GitHub stars](https://img.shields.io/github/stars/nschloe/tikzplotlib.svg?style=flat-square&logo=github&label=Stars&logoColor=white)](https://github.com/nschloe/tikzplotlib)
+[![PyPi downloads](https://img.shields.io/pypi/dd/tikzplotlib.svg?style=flat-square)](https://pypistats.org/packages/tikzplotlib)
+
+This is tikzplotlib, a Python tool for converting matplotlib figures into
 [PGFPlots](https://www.ctan.org/pkg/pgfplots) ([PGF/TikZ](https://www.ctan.org/pkg/pgf))
 figures like
 
-![](https://nschloe.github.io/matplotlib2tikz/example.png)
+![](https://nschloe.github.io/tikzplotlib/example.png)
 
 for native inclusion into LaTeX documents.
 
-The output of matplotlib2tikz is in
+The output of tikzplotlib is in
 [PGFPlots](http://pgfplots.sourceforge.net/pgfplots.pdf), a LaTeX library that sits on
 top of [PGF/TikZ](https://en.wikipedia.org/wiki/PGF/TikZ) and describes graphs in terms
-of axes, data etc. Consequently, the output of matplotlib2tikz
+of axes, data etc. Consequently, the output of tikzplotlib
 
   * retains more information,
   * can be more easily understood, and
@@ -45,9 +47,9 @@ plt.ylabel("Voltage (mV)")
 plt.title("Simple plot $\\frac{\\alpha}{2}$")
 plt.grid(True)
 
-import matplotlib2tikz
+import tikzplotlib
 
-matplotlib2tikz.save("test.tex")
+tikzplotlib.save("test.tex")
 ```
 (see above) gives
 ```latex
@@ -100,10 +102,10 @@ Notably, [3D plots don't work](https://github.com/matplotlib/matplotlib/issues/7
 
 ### Installation
 
-matplotlib2tikz is [available from the Python Package
-Index](https://pypi.org/project/matplotlib2tikz/), so simply type
+tikzplotlib is [available from the Python Package
+Index](https://pypi.org/project/tikzplotlib/), so simply type
 ```
-pip3 install matplotlib2tikz --user
+pip3 install tikzplotlib --user
 ```
 to install/update.
 
@@ -112,10 +114,10 @@ to install/update.
 
 1. Generate your matplotlib plot as usual.
 
-2. Instead of `pyplot.show()`, invoke matplotlib2tikz by
+2. Instead of `pyplot.show()`, invoke tikzplotlib by
     ```python
-    import matplotlib2tikz
-    matplotlib2tikz.save("mytikz.tex")
+    import tikzplotlib
+    tikzplotlib.save("mytikz.tex")
     ```
    to store the TikZ file as `mytikz.tex`.
 
@@ -138,15 +140,15 @@ to install/update.
 ### Contributing
 
 If you experience bugs, would like to contribute, have nice examples of what
-matplotlib2tikz can do, or if you are just looking for more information, then please
-visit [matplotlib2tikz's GitHub page](https://github.com/nschloe/matplotlib2tikz).
+tikzplotlib can do, or if you are just looking for more information, then please
+visit [tikzplotlib's GitHub page](https://github.com/nschloe/tikzplotlib).
 
 
 ### Testing
 
-matplotlib2tikz has automatic unit testing to make sure that the software doesn't
+tikzplotlib has automatic unit testing to make sure that the software doesn't
 accidentally get worse over time. In `test/`, a number of test cases are specified.
-Those run through matplotlib2tikz and compare the output with a previously stored
+Those run through tikzplotlib and compare the output with a previously stored
 reference TeX file.
 
 To run the tests, just check out this repository and type
@@ -156,4 +158,4 @@ pytest
 
 ### License
 
-matplotlib2tikz is published under the [MIT license](https://en.wikipedia.org/wiki/MIT_License).
+tikzplotlib is published under the [MIT license](https://en.wikipedia.org/wiki/MIT_License).

doc/Makefile

@@ -61,9 +61,9 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/matplotlib2tikz.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/tikzplotlib.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/matplotlib2tikz.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/tikzplotlib.qhc"
 
 latex:
 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

doc/conf.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-#
-# matplotlib2tikz documentation build configuration file, created by
+# tikzplotlib documentation build configuration file, created by
 # sphinx-quickstart on Mon May 10 14:00:31 2010.
 #
 # This file is execfile()d with the current directory set to its containing
@@ -12,8 +10,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
 import os
+import sys
 
 import mock
 
@@ -51,7 +49,7 @@
 master_doc = "index"
 
 # General information about the project.
-project = u"matplotlib2tikz"
+project = u"tikzplotlib"
 copyright = u"2010-2018, Nico Schlömer"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -61,7 +59,7 @@
 # https://packaging.python.org/single_source_version/
 this_dir = os.path.abspath(os.path.dirname(__file__))
 about = {}
-about_file = os.path.join(this_dir, "..", "matplotlib2tikz", "__about__.py")
+about_file = os.path.join(this_dir, "..", "tikzplotlib", "__about__.py")
 with open(about_file) as f:
     exec(f.read(), about)
 # The short X.Y version.
@@ -179,7 +177,7 @@
 # html_file_suffix = ''
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "matplotlib2tikzdoc"
+htmlhelp_basename = "tikzplotlibdoc"
 
 
 # -- Options for LaTeX output -------------------------------------------------
@@ -195,8 +193,8 @@
 latex_documents = [
     (
         "index",
-        "matplotlib2tikz.tex",
-        u"matplotlib2tikz Documentation",
+        "tikzplotlib.tex",
+        u"tikzplotlib Documentation",
         u"Nico Schlömer",
         "manual",
     )

doc/index.rst

@@ -1,9 +1,9 @@
-.. matplotlib2tikz documentation master file, created by
+.. tikzplotlib documentation master file, created by
    sphinx-quickstart on Mon May 10 14:00:31 2010.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to matplotlib2tikz's documentation!
+Welcome to tikzplotlib's documentation!
 ===========================================
 
 Contents:
@@ -14,7 +14,7 @@ Contents:
 Methods
 =======
 
-.. automodule:: matplotlib2tikz
+.. automodule:: tikzplotlib
   :members:
 
 Indices and tables

matplotlib2tikz/__about__.py

@@ -1,14 +1,12 @@
-# -*- coding: utf-8 -*-
-#
 import codecs
 import os
 
-from setuptools import setup, find_packages
+from setuptools import find_packages, setup
 
 # https://packaging.python.org/single_source_version/
 base_dir = os.path.abspath(os.path.dirname(__file__))
 about = {}
-with open(os.path.join(base_dir, "matplotlib2tikz", "__about__.py"), "rb") as f:
+with open(os.path.join(base_dir, "tikzplotlib", "__about__.py"), "rb") as f:
     exec(f.read(), about)
 
 
@@ -17,21 +15,18 @@ def read(fname):
 
 
 setup(
-    name="matplotlib2tikz",
+    name="tikzplotlib",
     version=about["__version__"],
     packages=find_packages(),
-    url="https://github.com/nschloe/matplotlib2tikz",
+    url="https://github.com/nschloe/tikzplotlib",
     author=about["__author__"],
     author_email=about["__email__"],
-    install_requires=["matplotlib >= 1.4.0", "numpy", "Pillow", "six"],
-    extras_require={
-        "all": ["pipdate >= 0.3.0, <0.4.0"],
-        "update": ["pipdate >= 0.3.0, <0.4.0"],
-    },
+    install_requires=["matplotlib >= 1.4.0", "numpy", "Pillow"],
     description="Convert matplotlib figures into TikZ/PGFPlots",
     long_description=read("README.md"),
     long_description_content_type="text/markdown",
     license=about["__license__"],
+    python_requires=">=3",
     classifiers=[
         about["__status__"],
         about["__license__"],

setup.py

@@ -1,13 +1,11 @@
-# -*- coding: utf-8 -*-
-#
 import os
 import subprocess
 import tempfile
 
 import matplotlib
 import matplotlib.pyplot as plt
 
-import matplotlib2tikz
+import tikzplotlib
 
 
 def print_tree(obj, indent=""):
@@ -35,7 +33,7 @@ def _unidiff_output(expected, actual):
 
 def assert_equality(plot, filename, **extra_get_tikz_code_args):
     plot()
-    code = matplotlib2tikz.get_tikz_code(
+    code = tikzplotlib.get_tikz_code(
         include_disclaimer=False, **extra_get_tikz_code_args
     )
     plt.close()
@@ -45,7 +43,7 @@ def assert_equality(plot, filename, **extra_get_tikz_code_args):
         reference = f.read()
     assert reference == code, _unidiff_output(code, reference)
 
-    code = matplotlib2tikz.get_tikz_code(
+    code = tikzplotlib.get_tikz_code(
         include_disclaimer=False, standalone=True, **extra_get_tikz_code_args
     )
     assert _compile(code) is not None
@@ -82,7 +80,7 @@ def _compile(code):
 
 def compare_mpl_latex(plot):
     plot()
-    code = matplotlib2tikz.get_tikz_code(standalone=True)
+    code = tikzplotlib.get_tikz_code(standalone=True)
     directory = os.getcwd()
     filename = "test-0.png"
     plt.savefig(filename)