Merge pull request #69 from echedey-ls/master

Modify installation and exposing of .mplstyles

.gitignore

@@ -7,3 +7,164 @@ dev/
 
 TODO.md
 new-version.md
+
+# 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/

SciencePlots/__init__.py

@@ -0,0 +1,19 @@
+from os import listdir
+from os.path import isdir, join
+
+import matplotlib.pyplot as plt
+
+import pkg_resources
+
+# register the included stylesheet in the matplotlib style library
+# TODO: migrate to importlib_resources when possible
+data_path = pkg_resources.resource_filename('scienceplots', 'styles/')
+stylesheets = plt.style.core.read_style_directory(data_path) # Reads styles in /styles
+# Reads styles in /styles subfolders
+for inode in listdir(data_path):
+    new_data_path = join(data_path, inode)
+    if isdir(new_data_path):
+        new_stylesheets = plt.style.core.read_style_directory(new_data_path)
+        stylesheets.update(new_stylesheets)
+# Update dictionary of styles
+plt.style.core.update_nested_dict(plt.style.library, stylesheets)

examples/plot-examples.py

@@ -2,7 +2,7 @@
 
 import numpy as np
 import matplotlib.pyplot as plt
-
+import scienceplots
 
 def model(x, p):
     return x ** (2 * p + 1) / (1 + x ** (2 * p))

setup.py

@@ -1,43 +1,48 @@
 """Install SciencePlots.
 
-This script (setup.py) will copy the matplotlib styles (*.mplstyle) into the
-appropriate directory on your computer (OS dependent).
-
-This code is based on a StackOverflow answer:
-https://stackoverflow.com/questions/31559225/how-to-ship-or-distribute-a-matplotlib-stylesheet
-
+This script (setup.py) will install the SciencePlots package.
+In order to expose .mplstyle files to matplotlib, "import scienceplots"
+must be called before plt.style.use(...).
 """
 
-import atexit
-import glob
+# Commented out code is due to how installation was made.
+# That code is based on a StackOverflow answer:
+# https://stackoverflow.com/questions/31559225/how-to-ship-or-distribute-a-matplotlib-stylesheet
+# It will remain here until a decision is made on if we should uninstall old versions or just ignore the issue.
+
+# import atexit
+# import glob
 import os
-import shutil
+# import shutil
 
-import matplotlib
+# import matplotlib
 from setuptools import setup
-from setuptools.command.install import install
+# from setuptools.command.install import install
+
+
+# def install_styles():
+#     # Find all style files
+#     stylefiles = glob.glob('styles/**/*.mplstyle', recursive=True)
+#     # Find stylelib directory (where the *.mplstyle files go)
+#     mpl_stylelib_dir = os.path.join(matplotlib.get_configdir(), "stylelib")
+#     if not os.path.exists(mpl_stylelib_dir):
+#         os.makedirs(mpl_stylelib_dir)
+#     # Copy files over
+#     print("Installing styles into", mpl_stylelib_dir)
+#     for stylefile in stylefiles:
+#         print(os.path.basename(stylefile))
+#         shutil.copy(
+#             stylefile,
+#             os.path.join(mpl_stylelib_dir, os.path.basename(stylefile)))
 
 
-def install_styles():
-    # Find all style files
-    stylefiles = glob.glob('styles/**/*.mplstyle', recursive=True)
-    # Find stylelib directory (where the *.mplstyle files go)
-    mpl_stylelib_dir = os.path.join(matplotlib.get_configdir(), "stylelib")
-    if not os.path.exists(mpl_stylelib_dir):
-        os.makedirs(mpl_stylelib_dir)
-    # Copy files over
-    print("Installing styles into", mpl_stylelib_dir)
-    for stylefile in stylefiles:
-        print(os.path.basename(stylefile))
-        shutil.copy(
-            stylefile,
-            os.path.join(mpl_stylelib_dir, os.path.basename(stylefile)))
+# ('notebook.mplstyle', 'scatter.mplstyle', 'science.mplstyle', 'bright.mplstyle', 'high-contrast.mplstyle', 'high-vis.mplstyle', 'light.mplstyle', 'muted.mplstyle', 'retro.mplstyle', 'std-colors.mplstyle', 'vibrant.mplstyle', 'ieee.mplstyle', 'nature.mplstyle', 'cjk-jp-font.mplstyle', 'cjk-kr-font.mplstyle', 'cjk-sc-font.mplstyle', 'cjk-tc-font.mplstyle', 'grid.mplstyle', 'latex-sans.mplstyle', 'no-latex.mplstyle', 'pgf.mplstyle', 'russian-font.mplstyle', 'sans.mplstyle')
 
 
-class PostInstallMoveFile(install):
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        atexit.register(install_styles)
+# class PostInstallMoveFile(install):
+#     def __init__(self, *args, **kwargs):
+#         super().__init__(*args, **kwargs)
+#         atexit.register(install_styles)
 
 
 # Get description from README
@@ -54,6 +59,19 @@ def __init__(self, *args, **kwargs):
     long_description=long_description,
     long_description_content_type='text/markdown',
     license="MIT",
+    url="https://github.com/garrettj403/SciencePlots/",
+
+    install_requires=['matplotlib'],
+    packages=["scienceplots"],
+    package_data={
+      'scienceplots': ['styles/**/*.mplstyle'],
+    },
+
+    classifiers=[
+        'Framework :: Matplotlib', 
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: 3'
+    ],
     keywords=[
         "matplotlib-style-sheets",
         "matplotlib-figures",
@@ -62,7 +80,5 @@ def __init__(self, *args, **kwargs):
         "matplotlib-styles",
         "python"
     ],
-    url="https://github.com/garrettj403/SciencePlots/",
-    install_requires=['matplotlib', ],
-    cmdclass={'install': PostInstallMoveFile, },
+    # cmdclass={'install': PostInstallMoveFile, },
 )