Seaborn original

.github/CONTRIBUTING.md

@@ -4,14 +4,26 @@ Contributing to seaborn
 General support
 ---------------
 
-General support questions ("how do I do <x>?") are most at home on [StackOverflow](https://stackoverflow.com/), where they will be seen by more people and are more easily searchable. StackOverflow has a `[seaborn]` tag, which will bring the question to the attention of people who might be able to answer.
+General support questions ("how do I do X?") are most at home on either [StackOverflow](https://stackoverflow.com/) or [discourse](https://discourse.matplotlib.org/c/3rdparty/seaborn/21), which have a larger audience of people who will see your post and may be able to offer assistance. StackOverflow is better for specific issues, while discourse is better for more open-ended discussion. Your chance of getting a quick answer will be higher if you include runnable code, a precise statement of what you are hoping to achieve, and a clear explanation of the problems that you have encountered.
 
 Reporting bugs
 --------------
 
-If you have encountered a bug in seaborn, please report it on the [Github issue tracker](https://github.com/mwaskom/seaborn/issues/new). It is only really possible to address bug reports if they include a reproducible script using randomly-generated data or one of the example datasets (accessed through `seaborn.load_dataset()`). Please also specify your versions of seaborn and matplotlib, as well as which matplotlib backend you are using.
+If you think you've encountered a bug in seaborn, please report it on the [Github issue tracker](https://github.com/mwaskom/seaborn/issues/new). To be useful, bug reports must include the following information:
+
+- A reproducible code example that demonstrates the problem
+- The output that you are seeing (an image of a plot, or the error message)
+- A clear explanation of why you think something is wrong
+- The specific versions of seaborn and matplotlib that you are working with
+
+Bug reports are easiest to address if they can be demonstrated using one of the example datasets from the seaborn docs (i.e. with `seaborn.load_dataset`). Otherwise, it is preferable that your example generate synthetic data to reproduce the problem. If you can only demonstrate the issue with your actual dataset, you will need to share it, ideally as a csv. Note that you can upload a csv directly to a github issue thread, but it must have a `.txt` suffix.
+
+If you've encountered an error, searching the specific text of the message before opening a new issue can often help you solve the problem quickly and avoid making a duplicate report.
+
+Because matplotlib handles the actual rendering, errors or incorrect outputs may be due to a problem in matplotlib rather than one in seaborn. It can save time if you try to reproduce the issue in an example that uses only matplotlib, so that you can report it in the right place. But it is alright to skip this step if it's not obvious how to do it.
+
 
 New features
 ------------
 
-If you think there is a new feature that should be added to seaborn, you can open an issue to discuss it. However, seaborn's development has become increasingly conservative, and the answer to most feature requests or proposed additions is "no". Polite requests with an explanation of the proposed feature's virtues will usually get an explanation; feature requests that say "I would like feature X, you need to add it" typically won't.
+If you think there is a new feature that should be added to seaborn, you can open an issue to discuss it. But please be aware that current development efforts are mostly focused on standardizing the API and internals, and there may be relatively low enthusiasm for novel features that do not fit well into short- and medium-term development plans.

.github/workflows/ci.yaml

@@ -0,0 +1,99 @@
+name : CI
+
+on:
+  push:
+    branches: master
+  pull_request:
+    branches: master
+
+env:
+  NB_KERNEL: python
+  MPLBACKEND: Agg
+
+jobs:
+
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+
+      - name: Install seaborn
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[all] -r ci/utils.txt
+
+      - name: Install doc tools
+        run: |
+          pip install -r doc/requirements.txt
+          sudo apt-get install pandoc
+
+      - name: Build docs
+        run: |
+          make -C doc -j `nproc` notebooks
+          make -C doc html
+
+
+  run-tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+
+        python: [3.7.x, 3.8.x, 3.9.x]
+        target: [test]
+        install: [all]
+        deps: [latest]
+        backend: [agg]
+
+        include:
+          - python: 3.7.x
+            target: unittests
+            install: all
+            deps: pinned
+            backend: agg
+          - python: 3.9.x
+            target: unittests
+            install: light
+            deps: latest
+            backend: agg
+          - python: 3.9.x
+            target: test
+            install: all
+            deps: latest
+            backend: tkagg
+
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install seaborn
+        run: |
+          python -m pip install --upgrade pip
+          if [[ ${{matrix.install}} == 'all' ]]; then EXTRAS='[all]'; fi
+          if [[ ${{matrix.deps }} == 'pinned' ]]; then DEPS='-r ci/deps_pinned.txt'; fi
+          pip install .$EXTRAS $DEPS -r ci/utils.txt
+
+      - name: Cache datastes
+        run: python ci/cache_test_datasets.py
+
+      - name: Run tests
+        env:
+          MPLBACKEND: ${{ matrix.backend }}
+        run: |
+          if [[ ${{ matrix.backend }} == 'tkagg' ]]; then PREFIX='xvfb-run -a'; fi
+          $PREFIX make ${{ matrix.target }}
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v1
+        if: ${{ success() }}

.gitignore

@@ -7,5 +7,8 @@ seaborn.egg-info/
 .cache/
 .coverage
 cover/
-.idea
+htmlcov/
+.idea/
+.vscode/
 .pytest_cache/
+notes/

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2019, Michael L. Waskom
+Copyright (c) 2012-2021, Michael L. Waskom
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

Makefile

@@ -1,13 +1,10 @@
 export SHELL := /bin/bash
 
 test:
-	pytest --doctest-modules seaborn
+	pytest -n auto --doctest-modules --cov=seaborn --cov-config=.coveragerc seaborn
 
 unittests:
-	pytest seaborn
-
-coverage:
-	pytest --doctest-modules --cov=seaborn --cov-config=.coveragerc seaborn
+	pytest -n auto --cov=seaborn --cov-config=.coveragerc seaborn
 
 lint:
-	flake8 --ignore E121,E123,E126,E226,E24,E704,E741,W503,W504 --exclude seaborn/__init__.py,seaborn/colors/__init__.py,seaborn/cm.py,seaborn/tests,seaborn/external seaborn
+	flake8 seaborn

README.md

@@ -1,40 +1,14 @@
-seaborn: statistical data visualization
-=======================================
-
-<div class="row">
-
-<a href=https://seaborn.pydata.org/examples/scatterplot_matrix.html>
-<img src="https://seaborn.pydata.org/_static/scatterplot_matrix_thumb.png" height="135" width="135">
-</a>
-
-<a href=http://seaborn.pydata.org/examples/errorband_lineplots.html>
-<img src="https://seaborn.pydata.org/_static/errorband_lineplots_thumb.png" height="135" width="135">
-</a>
-
-<a href=http://seaborn.pydata.org/examples/different_scatter_variables.html>
-<img src="http://seaborn.pydata.org/_static/different_scatter_variables_thumb.png" height="135" width="135">
-</a>
-
-<a href=https://seaborn.pydata.org/examples/many_facets.html>
-<img src="https://seaborn.pydata.org/_static/many_facets_thumb.png" height="135" width="135">
-</a>
-
-<a href=https://seaborn.pydata.org/examples/structured_heatmap.html>
-<img src="https://seaborn.pydata.org/_static/structured_heatmap_thumb.png" height="135" width="135">
-</a>
-
-<a href=https://seaborn.pydata.org/examples/horizontal_boxplot.html>
-<img src="https://seaborn.pydata.org/_static/horizontal_boxplot_thumb.png" height="135" width="135">
-</a>
-
-</div>
+<img src="doc/_static/logo-wide-lightbg.svg"><br>
 
 --------------------------------------
 
+seaborn: statistical data visualization
+=======================================
+
 [![PyPI Version](https://img.shields.io/pypi/v/seaborn.svg)](https://pypi.org/project/seaborn/)
 [![License](https://img.shields.io/pypi/l/seaborn.svg)](https://github.com/mwaskom/seaborn/blob/master/LICENSE)
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1313201.svg)](https://doi.org/10.5281/zenodo.1313201)
-[![Build Status](https://travis-ci.org/mwaskom/seaborn.svg?branch=master)](https://travis-ci.org/mwaskom/seaborn)
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.03021/status.svg)](https://doi.org/10.21105/joss.03021)
+![Tests](https://github.com/mwaskom/seaborn/workflows/CI/badge.svg)
 [![Code Coverage](https://codecov.io/gh/mwaskom/seaborn/branch/master/graph/badge.svg)](https://codecov.io/gh/mwaskom/seaborn)
 
 Seaborn is a Python visualization library based on matplotlib. It provides a high-level interface for drawing attractive statistical graphics.
@@ -47,39 +21,58 @@ Online documentation is available at [seaborn.pydata.org](https://seaborn.pydata
 
 The docs include a [tutorial](https://seaborn.pydata.org/tutorial.html), [example gallery](https://seaborn.pydata.org/examples/index.html), [API reference](https://seaborn.pydata.org/api.html), and other useful information.
 
+To build the documentation locally, please refer to [`doc/README.md`](doc/README.md).
 
 Dependencies
 ------------
 
-Seaborn supports Python 2.7 and 3.5+.
+Seaborn supports Python 3.7+ and no longer supports Python 2.
 
-Installation requires [numpy](http://www.numpy.org/), [scipy](https://www.scipy.org/), [pandas](https://pandas.pydata.org/), and [matplotlib](https://matplotlib.org/). Some functions will optionally use [statsmodels](https://www.statsmodels.org/) if it is installed.
+Installation requires [numpy](https://numpy.org/), [pandas](https://pandas.pydata.org/), and [matplotlib](https://matplotlib.org/). Some functions will optionally use [scipy](https://www.scipy.org/) and/or [statsmodels](https://www.statsmodels.org/) if they are available.
 
 
 Installation
 ------------
 
-The latest stable release (and older versions) can be installed from PyPI:
+The latest stable release (and required dependencies) can be installed from PyPI:
 
     pip install seaborn
 
+It is also possible to include the optional dependencies:
+
+    pip install seaborn[all]
+
 You may instead want to use the development version from Github:
 
-    pip install git+https://github.com/mwaskom/seaborn.git#egg=seaborn
+    pip install git+https://github.com/mwaskom/seaborn.git
+
+Seaborn is also available from Anaconda and can be installed with conda:
 
+    conda install seaborn
+
+Note that the main anaconda repository typically lags PyPI in adding new releases.
+
+Citing
+------
+
+A paper describing seaborn has been published in the [Journal of Open Source Software](https://joss.theoj.org/papers/10.21105/joss.03021). The paper provides an introduction to the key features of the library, and it can be used as a citation if seaborn proves integral to a scientific publication.
 
 Testing
 -------
 
-To test seaborn, run `make test` in the source directory.
+Testing seaborn requires installing additional packages listed in `ci/utils.txt`.
+
+To test the code, run `make test` in the source directory. This will exercise both the unit tests and docstring examples (using [pytest](https://docs.pytest.org/)) and generate a coverage report.
+
+The doctests require a network connection (unless all example datasets are cached), but the unit tests can be run offline with `make unittests`.
 
-This will exercise both the unit tests and docstring examples (using `pytest`).
 
+Code style is enforced with `flake8` using the settings in the [`setup.cfg`](./setup.cfg) file. Run `make lint` to check.
 
 Development
 -----------
 
 Seaborn development takes place on Github: https://github.com/mwaskom/seaborn
 
-Please submit any reproducible bugs you encounter to the [issue tracker](https://github.com/mwaskom/seaborn/issues).
+Please submit bugs that you encounter to the [issue tracker](https://github.com/mwaskom/seaborn/issues) with a reproducible example demonstrating the problem. Questions about usage are more at home on StackOverflow, where there is a [seaborn tag](https://stackoverflow.com/questions/tagged/seaborn).
 

ci/cache_test_datasets.py

@@ -0,0 +1,19 @@
+"""
+Cache test datasets before running test suites to avoid
+race conditions to due tests parallelization
+"""
+import seaborn as sns
+
+datasets = (
+    "anscombe",
+    "attention",
+    "dots",
+    "exercise",
+    "flights",
+    "fmri",
+    "iris",
+    "planets",
+    "tips",
+    "titanic"
+)
+list(map(sns.load_dataset, datasets))

ci/check_gallery.py

@@ -0,0 +1,14 @@
+"""Execute the scripts that comprise the example gallery in the online docs."""
+from glob import glob
+import matplotlib.pyplot as plt
+
+if __name__ == "__main__":
+
+    fnames = sorted(glob("examples/*.py"))
+
+    for fname in fnames:
+
+        print(f"- {fname}")
+        with open(fname) as fid:
+            exec(fid.read())
+        plt.close("all")

ci/deps_pinned.txt

@@ -0,0 +1,5 @@
+numpy~=1.16.0
+pandas~=0.24.0
+matplotlib~=3.0.0
+scipy~=1.2.0
+statsmodels~=0.9.0

ci/utils.txt

@@ -0,0 +1,4 @@
+pytest!=5.3.4
+pytest-cov
+pytest-xdist
+flake8