Skip to content

Updated Readme + Setup.py for PyPa #16626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 3, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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).
59 changes: 23 additions & 36 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <http://matplotlib.org/>`_ 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 <http://matplotlib.org/>`_

Install
=======

For installation instructions and requirements, see the INSTALL.rst file or the
`install <http://matplotlib.org/users/installing.html>`_ documentation. If you
think you may want to contribute to matplotlib, check out the `guide to
working with the source code
<http://matplotlib.org/devel/gitwash/index.html>`_.
For installation instructions and requirements, see `INSTALL.rst <INSTALL.rst>`_ or the
`install <http://matplotlib.org/users/installing.html>`_ documentation.

Test
====

After installation, you can launch the test suite::
After installation, launch the test suite::

pytest
python -m pytest

Read the `testing guide <https://matplotlib.org/devel/testing.html>`_ 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 <http://matplotlib.org/devdocs/devel/contributing.html>`_!

Contact
=======
Expand All @@ -91,24 +89,13 @@ Our active mailing lists (which are mirrored on Discourse) are:
* `Announcement <https://mail.python.org/mailman/listinfo/matplotlib-announce>`_ mailing list: matplotlib-announce@python.org
* `Development <https://mail.python.org/mailman/listinfo/matplotlib-devel>`_ 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 <http://matplotlib.org/devdocs/devel/contributing.html>`_!

Developer notes are now at `Developer Discussions <https://github.com/orgs/matplotlib/teams/developers/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 <https://matplotlib.org/citing.html>`_ is available.
Binary file added doc/_static/readme_preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 11 additions & 8 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down Expand Up @@ -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",
Expand All @@ -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"},
Expand Down