diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f5c602c0d7b8..c4198cdcdf14 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,2 +1 @@ -Please refer to the [Coding -Guidelines](http://matplotlib.org/devel/coding_guide.html). +Please refer to the [developers guide](https://matplotlib.org/devel/index.html). diff --git a/README.rst b/README.rst index fb388040c7f9..000d916be2b9 100644 --- a/README.rst +++ b/README.rst @@ -40,46 +40,44 @@ .. |NUMFocus| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A .. _NUMFocus: http://www.numfocus.org +.. image:: doc/_static/logo2.png -########## -Matplotlib -########## +Matplotlib is a comprehensive library for creating static, animated, and interactive visualizations in Python. -Matplotlib is a Python 2D plotting library which produces publication-quality -figures in a variety of hardcopy formats and interactive environments across -platforms. Matplotlib can be used in Python scripts, the Python and IPython -shell (à la MATLAB or Mathematica), web application servers, and various -graphical user interface toolkits. +Check out our `home page `_ for more information. + +.. image:: doc/_static/readme_preview.png -NOTE: The current master branch is now Python 3 only. Python 2 support is -being dropped. +Matplotlib produces publication-quality figures in a variety of hardcopy formats +and interactive environments across platforms. Matplotlib can be used in Python scripts, +the Python and IPython shell, web application servers, and various +graphical user interface toolkits. -`Home page `_ Install ======= -For installation instructions and requirements, see the INSTALL.rst file or the -`install `_ documentation. If you -think you may want to contribute to matplotlib, check out the `guide to -working with the source code -`_. +For installation instructions and requirements, see `INSTALL.rst `_ or the +`install `_ documentation. Test ==== -After installation, you can launch the test suite:: +After installation, launch the test suite:: - pytest + python -m pytest + +Read the `testing guide `_ for more information and alternatives. + +Contribute +========== +You've discovered a bug or something else you want to change - excellent! -Or from the Python interpreter:: +You've worked out a way to fix it – even better! - import matplotlib - matplotlib.test() +You want to tell us about it – best of all! -Consider reading http://matplotlib.org/devel/coding_guide.html#testing for more -information. Note that the test suite requires pytest. Please install with pip -or your package manager of choice. +Start at the `contributing guide `_! Contact ======= @@ -91,24 +89,13 @@ Our active mailing lists (which are mirrored on Discourse) are: * `Announcement `_ mailing list: matplotlib-announce@python.org * `Development `_ mailing list: matplotlib-devel@python.org - Gitter_ is for coordinating development and asking questions directly related to contributing to matplotlib. -Contribute -========== -You've discovered a bug or something else you want to change - excellent! - -You've worked out a way to fix it – even better! - -You want to tell us about it – best of all! - -Start at the `contributing guide `_! - -Developer notes are now at `Developer Discussions `_ (Note: For technical reasons, this is currently only accessible for matplotlib developers.) Citing Matplotlib ================= If Matplotlib contributes to a project that leads to publication, please acknowledge this by citing Matplotlib. + `A ready-made citation entry `_ is available. diff --git a/doc/_static/readme_preview.png b/doc/_static/readme_preview.png new file mode 100644 index 000000000000..f7e6b7833508 Binary files /dev/null and b/doc/_static/readme_preview.png differ diff --git a/setup.py b/setup.py index 454727bd2394..0d8919a013f1 100644 --- a/setup.py +++ b/setup.py @@ -76,6 +76,7 @@ classifiers = [ 'Development Status :: 5 - Production/Stable', 'Intended Audience :: Science/Research', + 'Intended Audience :: Education', 'License :: OSI Approved :: Python Software Foundation License', 'Programming Language :: Python', 'Programming Language :: Python :: 3', @@ -221,6 +222,10 @@ def run(self): with open('lib/matplotlib/mpl-data/matplotlibrc', 'w') as fd: fd.write(''.join(template_lines)) + # Use Readme as long description + with open('README.rst') as fd: + long_description = fd.read() + # Finally, pass this all along to distutils to do the heavy lifting. setup( name="matplotlib", @@ -231,16 +236,14 @@ def run(self): url="https://matplotlib.org", download_url="https://matplotlib.org/users/installing.html", project_urls={ + 'Documentation': 'https://matplotlib.org', + 'Source Code': 'https://github.com/matplotlib/matplotlib', 'Bug Tracker': 'https://github.com/matplotlib/matplotlib/issues', - 'Documentation': 'https://matplotlib.org/contents.html', - 'Source Code': 'https://github.com/matplotlib/matplotlib' + 'Forum': 'https://discourse.matplotlib.org/', + 'Donate': 'https://numfocus.org/donate-to-matplotlib' }, - long_description=""" - Matplotlib strives to produce publication quality 2D graphics - for interactive graphing, scientific publishing, user interface - development and web application servers targeting multiple user - interfaces and hardcopy output formats. - """, + long_description=long_description, + long_description_content_type="text/x-rst", license="PSF", platforms="any", package_dir={"": "lib"},