initial commit

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,44 @@
+---
+name: 🐛 Bug Report
+about: Report a bug
+# based on matplotlib issue template
+---
+
+<!--To help us understand and resolve your issue, please fill out the form to the best of your ability.-->
+<!--You can feel free to delete the sections that do not apply.-->
+
+### Bug report
+
+**Bug summary**
+
+<!--A short 1-2 sentences that succinctly describes the bug-->
+
+**Code for reproduction**
+
+<!--A minimum code snippet required to reproduce the bug.
+Please make sure to minimize the number of dependencies required, and provide
+any necessary plotted data.
+
+```python
+# Paste your code here
+#
+#
+```
+
+**Actual outcome**
+
+<!--The output produced by the above code, which may be a screenshot, console output, etc.-->
+
+**Expected outcome**
+
+<!--A description of the expected outcome from the code snippet-->
+<!--If this used to work in an earlier version of Matplotlib, please note the version it used to work on-->
+
+**Version Info**
+<!--Please specify your platform and versions of the relevant libraries you are using:-->
+  * Operating system:
+  * Matplotlib version: 
+  * Matplotlib backend (`print(matplotlib.get_backend())`):
+  * Python version:
+  * Jupyter version (if applicable):
+  * Other libraries: 

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,6 @@
+# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
+blank_issues_enabled: true # default
+contact_links:
+  - name: ❓ Question/Support/Other
+    url: https://discourse.matplotlib.org/c/3rdparty/18
+    about: If you have a usage question

.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,29 @@
+---
+name: 📖 Documentation improvement
+about: Report parts of the docs that are wrong or unclear
+labels: documentation, bug
+---
+
+<!--To help us understand and resolve your issue, please fill out the form to the best of your ability.-->
+<!--You can feel free to delete the sections that do not apply.-->
+
+### Problem
+
+<!--
+If you are referencing an existing piece of documentation or example please provide a link.
+
+* I found [...] to be unclear because [...]
+* [...] made me think that [...] when really it should be [...]
+* There is no example showing how to do [...]
+-->
+
+
+### Suggested Improvement
+
+<!--
+If you have an idea to improve the documentation please suggest it here
+
+* This line should be be changed to say [...]
+* Include a paragraph explaining [...]
+* Add a figure showing [...]
+-->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,35 @@
+---
+name: 🚀 Enhancement/Feature Request
+about: Suggest something that could be improved or a New Feature to add
+labels: enhancement
+---
+
+<!--
+Welcome! Thanks for thinking of a way to improve mpl_visual_context. If this solves a problem for you, then it probably solves that problem for lots of people! So the whole community will benefit from this request.
+
+
+Before creating a new feature request please search the issues for relevant feature requests.
+-->
+
+### Problem
+
+<!-- Provide a clear and concise description of what problem this feature will solve. For example:
+
+* I'm always frustrated when [...] because [...]
+* I would like it if [...] happened when I [...] because [...]
+-->
+
+### Proposed Solution
+
+<!-- Provide a clear and concise description of a way to accomplish what you want. For example:
+
+* Add an option so that when [...]  [...] will happen
+ -->
+
+### Additional context
+
+<!-- Add any other context or screenshots about the feature request here. You can also include links to examples of other programs that have something similar to your request. For example:
+
+* Another project [...] solved this by [...]
+-->
+

.github/workflows/lint.yml

@@ -0,0 +1,27 @@
+name: Lint
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - uses: psf/black@stable
+        with:
+          options: "--check"
+          src: "."
+      - name: docstrings
+        run: |
+          pip install flit
+          pushd $(mktemp -d)
+          git clone https://github.com/Carreau/velin.git --single-branch --depth 1
+          cd velin
+          flit install
+          popd
+          velin . --check

.github/workflows/publish.yml

@@ -0,0 +1,28 @@
+# heavily based on https://github.com/jupyterlab/jupyterlab-git/blob/v0.22.2/.github/workflows/publish.yml
+name: Publish Package
+
+on:
+  release:
+    types: [published]
+
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install packaging setuptools twine wheel build
+    - name: Publish the Python package
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+      run: |
+        python -m build -s -w
+        twine upload dist/*

.github/workflows/test.yml

@@ -0,0 +1,57 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  schedule:
+    - cron: "0 16 * * 1" # monday at noon est
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }} - mpl ${{ matrix.mpl-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8.x', '3.9.x']
+        mpl-version: ['3.4', 'latest']
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: 'x64'
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: |
+          echo "::set-output name=dir::$(pip cache dir)"
+  
+      - name: pip cache
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('**/setup.py') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-${{ matrix.python-version }}-
+            ${{ runner.os }}-pip-
+
+      - if: matrix.mpl-version=='latest'
+        name: Install dev Matplotlib
+        run: pip install git+https://github.com/matplotlib/matplotlib.git
+
+      - if: matrix.mpl-version!='latest'
+        name: Install matplotlib pinned
+        run: pip install --upgrade --pre --index-url https://pypi.anaconda.org/scipy-wheels-nightly/simple --extra-index-url https://pypi.org/simple matplotlib
+
+      - name: Install
+        run: |
+          pip install ".[test]"
+
+      - name: Tests
+        run: |
+          pytest --mpl --color=yes

.gitignore

@@ -0,0 +1,155 @@
+# 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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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/
+
+# mac stuff
+.DS_store
+
+# editors
+
+## vim
+[._]*.s[a-v][a-z]
+!*.svg  # comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+[._]*.un~
+
+## vscode
+.vscode