ultraplot 0.99.3__tar.gz

ultraplot-0.99.3/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,31 @@
+<!-- Thanks for helping us make ultraplot a better package! If this is a bug report, please use the template provided below. If this is a feature request, you can delete the template text (just try to be descriptive with your request). -->
+
+### Description
+
+[Description of the bug or feature.]
+
+### Steps to reproduce
+
+A "[Minimal, Complete and Verifiable Example](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)" will make it much easier for maintainers to help you.
+
+```python
+# your code here
+# we should be able to copy-paste this into python and exactly reproduce your bug
+```
+
+**Expected behavior**: [What you expected to happen]
+
+**Actual behavior**: [What actually happened]
+
+### Equivalent steps in matplotlib
+
+Please try to make sure this bug is related to a ultra-specific feature. If you're not sure, try to replicate it with the [native matplotlib API](https://matplotlib.org/3.1.1/api/index.html). Matplotlib bugs belong on the [matplotlib github page](https://github.com/matplotlib/matplotlib).
+
+```python
+# your code here, if applicable
+import matplotlib.pyplot as plt
+```
+
+### Ultra version
+
+Paste the results of `import matplotlib; print(matplotlib.__version__); import ultra; print(ultra.version)` here.

ultraplot-0.99.3/.github/workflows/ultraplot.yml

@@ -0,0 +1,117 @@
+name: Build and Test
+on:
+  push:
+    branches: [main]
+    tags: ["v*"]
+  pull_request:
+    branches: [main]
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v3
+      - uses: mamba-org/setup-micromamba@v2.0.3
+        with:
+          environment-file: ./environment-dev.yml
+          init-shell: >-
+            bash
+          create-args: >-
+            --verbose
+          cache-environment: true
+          cache-downloads: false
+
+      - name: Test Ultraplot
+        shell: bash -el {0}
+        run: |
+          micromamba activate ultraplot-dev
+          pip install .
+          python -m pytest
+
+      - name: "Build docs"
+        shell: bash -el {0}
+        run: |
+          micromamba activate ultraplot-dev
+          cd docs
+          make html
+
+  publish-test:
+    needs: build
+    runs-on: ubuntu-latest
+    # Run on every push to main/v* branches and pull requests
+    if: github.event_name == 'push' || github.event_name == 'pull_request'
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+
+      - name: Install build
+        run: python -m pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish:
+    needs: [build, publish-test]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags/v')
+    permissions:
+      # Required for trusted publishing to PyPI
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+
+      - name: Install build
+        run: python -m pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Publish to Anaconda
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          auto-activate-base: false
+          environment-file: environment-dev.yml
+
+      - name: Install conda-build
+        shell: bash -l {0}
+        run: |
+          micromamba activate ultraplot-dev
+          micromamba install conda-build anaconda-client
+
+      - name: Build and publish to Anaconda Cloud
+        uses: anaconda/upload-conda-package@vi1
+        with:
+          user: cvanelteren
+          token: ${{ secrets.ANACONDA_TOKEN }}
+          label: main

ultraplot-0.99.3/.gitignore

@@ -0,0 +1,39 @@
+# VIM extras
+.session.vim
+.vimsession
+.*.sw[a-z]
+
+# PyPi stuff
+build
+dist
+.eggs
+*.egg-info
+
+# Local docs builds
+docs/api
+docs/_build
+docs/_static/ultraplotrc
+docs/_static/rctable.rst
+docs/_static/*
+
+# Development subfolders
+dev
+sources
+
+# Python extras
+.ipynb_checkpoints
+*.log
+*.pyc
+.*.pyc
+__pycache__
+
+# OS files
+.DS_Store
+.DS_Store?
+._*
+.Trashes
+
+# Old files
+tmp
+trash
+garbage

ultraplot-0.99.3/.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+# See: https://pre-commit.com/hooks.html
+# Must put flake8 in separate group so 'black' is executed first
+# WARNING: Make sure to keep flags in sync with ci/run-linter.sh
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+    - id: double-quote-string-fixer
+    - id: check-docstring-first
+    - id: check-merge-conflict
+    - id: end-of-file-fixer
+    - id: trailing-whitespace
+
+  - repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.10.1
+    hooks:
+    - id: isort
+      args: ['--line-width=88', '--multi-line=3', '--force-grid-wrap=0', '--trailing-comma']
+      exclude: '(^docs|__init__)'
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 4.0.1
+    hooks:
+    - id: flake8
+      args: ['--max-line-length=88', '--ignore=W503,E402,E731,E741']
+
+  # apply once this handles long tables better
+  # - repo: https://github.com/PyCQA/doc8
+  #   rev: 0.10.1
+  #   hooks:
+  #   - id: doc8
+  #     args: ['--max-line-length', '88', '--allow-long-titles']
+
+  # apply after function keyword args can be ignored
+  # - repo: https://github.com/ambv/black
+  #   rev: 22.1.0
+  #   hooks:
+  #   - id: black
+  #     args: ['--line-length', '88', '--skip-string-normalization']

ultraplot-0.99.3/.readthedocs.yml

@@ -0,0 +1,25 @@
+ # .readthedocs.yml
+# Read the Docs configuration file
+version: 2
+
+# Python config
+build:
+  os: ubuntu-22.04
+  tools:
+    python: mambaforge-latest
+  jobs:
+    pre_build:
+  jobs:
+    pre_build:
+      - locale -a
+      - export LC_ALL=en_US.UTF-8
+      - export LANG=en_US.UTF-8
+      - pytest
+
+
+conda:
+  environment: ./docs/environment.yml
+
+sphinx:
+  configuration: ./docs/conf.py
+  builder: html

ultraplot-0.99.3/.travis.yml

@@ -0,0 +1,42 @@
+# Travis Continuos Integration
+# Currently only tests notebook files
+# Based on https://conda.pydata.org/docs/travis.html
+sudo: false # use container based build
+language: python
+dist: focal
+notifications:
+  email: false
+
+python:
+  - "3.7"
+
+before_install:
+  - |
+    MODIFIED_FILES=$(git diff --name-only "$TRAVIS_COMMIT_RANGE" 2>/dev/null)
+    if [ $? -eq 0 ] && ! echo "$MODIFIED_FILES" | grep -qvE '(.md)|(.rst)|(.html)|(.png)|(.ico)'
+      then
+      echo "Only doc files were updated, not running the CI."
+      exit
+    fi
+  - wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh
+  - bash miniconda.sh -b -p $HOME/miniconda
+  - export PATH="$HOME/miniconda/bin:$PATH"
+  - hash -r
+  - conda config --set always_yes yes --set changeps1 no --set show_channel_urls true
+  - conda update -q conda
+  - conda info -a
+
+install:
+  - conda env create --file ci/environment.yml
+  - source activate ultra-dev
+  - conda list
+  - which conda
+  - which python
+  - python setup.py sdist bdist_wheel
+  - pip install --user ./dist/*.whl
+
+script:
+  - ci/run-linter.sh
+  - pushd docs
+  - make html
+  - popd

ultraplot-0.99.3/CODEOFCONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+lukelbd@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

ultraplot-0.99.3/CONTRIBUTING.rst

@@ -0,0 +1,271 @@
+.. _contrib:
+
+==================
+How to contribute?
+==================
+
+Contributions of any size are greatly appreciated! You can
+make a significant impact on ultraplot by just using it and
+reporting `issues <https://github.com/ultraplot/ultraplot/issues>`__.
+
+The following sections cover some general guidelines
+regarding ultraplot development for new contributors. Feel
+free to suggest improvements or changes to this workflow.
+
+.. _contrib_features:
+
+Feature requests
+================
+
+We are eager to hear your requests for new features and
+suggestions regarding the current API. You can submit these as
+`issues <https://github.com/ultraplot/ultraplot/issues/new>`__ on Github.
+Please make sure to explain in detail how the feature should work and keep the scope as
+narrow as possible. This will make it easier to implement in small pull requests.
+
+If you are feeling inspired, feel free to add the feature yourself and
+submit a pull request!
+
+.. _contrib_bugs:
+
+Report bugs
+===========
+
+Bugs should be reported using the Github
+`issues <https://github.com/ultraplot/ultraplot/issues>`__ page. When reporting a
+bug, please follow the template message and include copy-pasteable code that
+reproduces the issue. This is critical for contributors to fix the bug quickly.
+
+If you can figure out how to fix the bug yourself, feel free to submit
+a pull request.
+
+.. _contrib_tets:
+
+Write tests
+===========
+
+Most modern python packages have ``test_*.py`` scripts that are run by `pytest`
+via continuous integration services like `Travis <https://travis-ci.com>`__
+whenever commits are pushed to the repository. Currently, ultraplot's continuous
+integration includes only the examples that appear on the website User Guide (see
+`.travis.yml`), and `Casper van Elteren <https://github.com/cvanelteren>` runs additional tests
+manually. This approach leaves out many use cases and leaves the project more
+vulnerable to bugs. Improving ultraplot's continuous integration using `pytest`
+and `pytest-mpl` is a *critical* item on our to-do list.
+
+If you can think of a useful test for ultraplot, feel free to submit a pull request.
+Your test will be used in the future.
+
+.. _contrib_docs:
+
+Write documentation
+===================
+
+Documentation can always be improved. For minor changes, you can edit docstrings and
+documentation files directly in the GitHub web interface without using a local copy.
+
+* The docstrings are written in
+  `reStructuredText <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`__
+  with `numpydoc <https://numpydoc.readthedocs.io/en/latest/>`__ style headers.
+  They are embedded in the :ref:`API reference` section using a
+  `fork of sphinx-automodapi <https://github.com/lukelbd/sphinx-automodapi>`__.
+* Other sections are written using ``.rst`` files and ``.py`` files in the ``docs``
+  folder. The ``.py`` files are translated to python notebooks via
+  `jupytext <https://jupytext.readthedocs.io/en/latest/>`__ then embedded in
+  the User Guide using `nbsphinx <https://nbsphinx.readthedocs.io/en/0.5.0/>`__.
+* The `default ReST role <https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-default_role>`__
+  is ``py:obj``. Please include ``py:obj`` links whenever discussing particular
+  functions or classes -- for example, if you are discussing the
+  `~ultraplot.axes.Axes.format` method, please write
+  ```~ultraplot.axes.Axes.format``` rather than ``format``. ultraplot also uses
+  `intersphinx <http://www.sphinx-doc.org/en/stable/ext/intersphinx.html>`__
+  so you can link to external packages like matplotlib and cartopy.
+
+To build the documentation locally, use the following commands:
+
+.. code:: bash
+
+   cd docs
+   # Install dependencies to the base conda environment..
+   conda env update -f environment.yml
+   # ...or create a new conda environment
+   # conda env create -n ultraplot-dev --file docs/environment.yml
+   # source activate ultraplot-dev
+   # Create HTML documentation
+   make html
+
+The built documentation should be available in ``docs/_build/html``.
+
+.. _contrib_pr:
+
+Preparing pull requests
+=======================
+
+New features and bug fixes should be addressed using pull requests.
+Here is a quick guide for submitting pull requests:
+
+#. Fork the
+   `ultraplot GitHub repository <https://github.com/ultraplot/ultraplot>`__.  It's
+   fine to keep "ultraplot" as the fork repository name because it will live
+   under your account.
+
+#. Clone your fork locally using `git <https://git-scm.com/>`__, connect your
+   repository to the upstream (main project), and create a branch as follows:
+
+   .. code-block:: bash
+
+      git clone git@github.com:YOUR_GITHUB_USERNAME/ultraplot.git
+      cd ultraplot
+      git remote add upstream git@github.com:ultraplot/ultraplot.git
+      git checkout -b your-branch-name master
+
+   If you need some help with git, follow the
+   `quick start guide <https://git.wiki.kernel.org/index.php/QuickStart>`__.
+
+#. Make an editable install of ultraplot by running:
+
+   .. code-block:: bash
+
+      pip install -e .
+
+   This way ``import ultraplot`` imports your local copy,
+   rather than the stable version you last downloaded from PyPi.
+   You can ``import ultraplot; print(ultraplot.__file__)`` to verify your
+   local copy has been imported.
+
+#. Install `pre-commit <https://pre-commit.com>`__ and its hook on the
+   ``ultraplot`` repo as follows:
+
+   .. code-block:: bash
+
+      pip install --user pre-commit
+      pre-commit install
+
+   Afterwards ``pre-commit`` will run whenever you commit.
+   `pre-commit <https://pre-commit.com/>`__ is a framework for managing and
+   maintaining multi-language pre-commit hooks to
+   ensure code-style and code formatting is consistent.
+
+#. You can now edit your local working copy as necessary. Please follow
+   the `PEP8 style guide <https://www.python.org/dev/peps/pep-0008/>`__.
+   and try to generally adhere to the
+   `black <https://black.readthedocs.io/en/stable/>`__ subset of the PEP8 style
+   (we may automatically enforce the "black" style in the future).
+   When committing, ``pre-commit`` will modify the files as needed,
+   or will generally be clear about what you need to do to pass the pre-commit test.
+
+   Please break your edits up into reasonably sized commits:
+
+
+   .. code-block:: bash
+
+      git commit -a -m "<commit message>"
+      git push -u
+
+   The commit messages should be short, sweet, and use the imperative mood,
+   e.g. "Fix bug" instead of "Fixed bug".
+
+   ..
+      #. Run all the tests. Now running tests is as simple as issuing this command:
+         .. code-block:: bash
+            coverage run --source ultraplot -m py.test
+         This command will run tests via the ``pytest`` tool against Python 3.7.
+
+#. If you intend to make changes or add examples to the user guide, you may want to
+   open the ``docs/*.py`` files as
+   `jupyter notebooks <https://jupyter-notebook.readthedocs.io/en/stable/>`__.
+   This can be done by
+   `installing jupytext <https://jupytext.readthedocs.io/en/latest/install.html>`__,
+   starting a jupyter session, and opening the ``.py`` files from the ``Files`` page.
+
+#. When you're finished, create a new changelog entry in ``CHANGELOG.rst``.
+   The entry should be entered as:
+
+   .. code-block::
+
+      * <description> (:pr:`<PR number>`) by `<author name>`_.
+
+   where ``<description>`` is the description of the PR related to the change,
+   ``<PR number>`` is the pull request number, and ``<author name>`` is your first
+   and last name. Make sure to add yourself to the list of authors at the end of
+   ``CHANGELOG.rst`` and the list of contributors in ``docs/authors.rst``.
+   Also make sure to add the changelog entry under one of the valid
+   ``.. rubric:: <heading>`` headings listed at the top of ``CHANGELOG.rst``.
+
+#. Finally, submit a pull request through the GitHub website using this data:
+
+   .. code-block::
+
+      head-fork: YOUR_GITHUB_USERNAME/ultraplot
+      compare: your-branch-name
+
+      base-fork: ultraplot/ultraplot
+      base: master
+
+Note that you can create the pull request before you're finished with your
+feature addition or bug fix. The PR will update as you add more commits. ultraplot
+developers and contributors can then review your code and offer suggestions.
+
+.. _contrib_release:
+
+Release procedure
+=================
+
+Once version 1.0 is released, ultraplot will follow semantic versioning. That is, given
+a version number ``X.Y.Z``, the major version ``X`` will be incremented when something
+is deprecated, the minor version ``Y`` will be incremented when features are added,
+and the patch number ``Z`` will be incremented when bugs are fixed.
+
+Currently, ultraplot's major version number is ``0``, reflecting the fact that the API
+is new and subject to rapid changes. Similar to semantic versioning, the minor version
+number is incremented when something is deprecated or the style is changed, and the
+patch number is incremented only when features are added or bugs are fixed.
+
+For now, `Casper van Eltern <https://github.com/cvanelteren>`__ is the only one who can
+publish releases on PyPi, but this will change in the future. Releases should
+be carried out as follows:
+
+#. Create a new branch ``release-vX.Y.Z`` with the version for the release.
+
+#. Make sure to update ``CHANGELOG.rst`` and that all new changes are reflected
+   in the documentation:
+
+   .. code-block:: bash
+
+      git add CHANGELOG.rst
+      git commit -m 'Update changelog'
+
+#. Open a new pull request for this branch targeting ``master``.
+
+#. After all tests pass and the pull request has been approved, merge into
+   ``master``.
+
+#. Get the latest version of the master branch:
+
+   .. code-block:: bash
+
+      git checkout master
+      git pull
+
+#. Tag the current commit and push to github:
+
+   .. code-block:: bash
+
+      git tag -a vX.Y.Z -m "Version X.Y.Z"
+      git push origin master --tags
+
+#. Build and publish release on PyPI:
+
+   .. code-block:: bash
+
+      # Remove previous build products and build the package
+      rm -r dist build *.egg-info
+      python setup.py sdist bdist_wheel
+      # Check the source and upload to the test repository
+      twine check dist/*
+      twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+      # Go to https://test.pypi.org/project/ultraplot/ and make sure everything looks ok
+      # Then make sure the package is installable
+      pip install --index-url https://test.pypi.org/simple/ ultraplot
+      # Register and push to pypi
+      twine upload dist/*