From d751743bca9413c56f52430724ec791f7178f102 Mon Sep 17 00:00:00 2001 From: Nicolas Kruchten Date: Wed, 27 Mar 2019 16:04:51 -0400 Subject: [PATCH 1/2] clean up PyPI metadata --- MANIFEST.in | 1 - README.rst | 115 ---------------------------------------------------- setup.cfg | 2 +- setup.py | 11 +++-- 4 files changed, 8 insertions(+), 121 deletions(-) delete mode 100644 README.rst diff --git a/MANIFEST.in b/MANIFEST.in index bf504c2cda0..115f2b9147a 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,5 +1,4 @@ include LICENSE.txt -include README.rst include README.md include plotlywidget.json include versioneer.py diff --git a/README.rst b/README.rst deleted file mode 100644 index e2481bc517a..00000000000 --- a/README.rst +++ /dev/null @@ -1,115 +0,0 @@ -======= -plotly: -======= --------------------------- -It's all about the graphs. --------------------------- - -The Nutshell -~~~~~~~~~~~~ - -Use this package to make collaborative, interactive, -publication-quality graphs from Python. - -Here's how you import:: - - import plotly.plotly as py # for sending things to plotly - import plotly.tools as tls # for mpl, config, etc. - from plotly.graph_objs import * # __all__ is safely defined - -Here's how you sign in:: - - py.sign_in('PythonAPI', 'ubpiol2cve') # get your own at https://plot.ly/ - -Here's how you plot data or a figure:: - - py.plot(data_or_figure_here) - -Here's what you get: - -* an account on plotly -* a unique url for your data/figures -* an interactive web-application to edit your figure or make new figures -* a platform on which to share your data/figures with the world - -You can also convert supported matplotlib figures:: - - py.plot_mpl(mplfig) - -Stop fighting with your figures; start designing them. Check out our -Quickstart_ to get going. - - -About -~~~~~ - -Plotly_ is an online collaborative data analysis and graphing tool. The -Python API allows you to access all of Plotly's functionality from Python. -Plotly figures are shared, tracked, and edited all online and the data is -always accessible from the graph. - -That's it. Find out more, sign up, and start sharing by visiting us at -https://plot.ly. - -Install via pip -~~~~~~~~~~~~~~~ - -Assuming you have already installed pip, you can simply enter the following -in a terminal program:: - - $ pip install plotly - -Contributing! -~~~~~~~~~~~~~ - -If you want to contribute to making Plotly's Python API experience better, -head to our `GitHub repo`_. Instructions for installing from here, -updating the included submodules, and contributing are detailed there! - -Plotly, matplotlib, and mpld3 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The matplotlylib sub-package allows you to convert matplotlib figures to -plotly figures, with a one-liner:: - - py.plot_mpl(fig) - -Checkout the `Plotly and mpld3`_ IPython notebook for more information. - -Introduction to working with out API -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Checkout the `Plotly and Python`_ IPython notebook to get a more in depth -exposition of our Python API. - -Plotly's *guide book* -~~~~~~~~~~~~~~~~~~~~~ - -Still here? Don't worry, we've got more documentation for you. Checkout a -*highly* complete `set of notebooks`_ for walk-throughs on all the features -we offer! - -Details -~~~~~~~ - -The plotly package depends on requests, which will be installed by pip for you. - -To use the matplotlylib subpackage, you'll also need to have matplotlib 1.3.1 -properly installed on your machine. - -The matpotlylib package is based on the mplexporter framework for crawling -and exporting matplotlib images. - -Created by: Plotly_, `@plotlygraphs`_, `feedback@plot.ly`_ - -License: MIT - -.. _Plotly: https://plot.ly -.. _Quickstart: https://plot.ly/python -.. _GitHub repo: https://github.com/plotly/python-api -.. _Plotly and mpld3: https://plot.ly/python/matplotlib-to-plotly-tutorial/ -.. _Plotly and Python: https://plot.ly/python/overview/ -.. _set of notebooks: https://plot.ly/python/user-guide/ -.. _plotly profile: https://plot.ly/~mpld3/ -.. _@plotlygraphs: https://twitter.com/plotlygraphs -.. _feedback@plot.ly: feedback@plot.ly diff --git a/setup.cfg b/setup.cfg index acc325260e5..a583e9ef140 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [metadata] -description-file = README.rst +description-file = README.md license_file = LICENSE.txt [bdist_wheel] diff --git a/setup.py b/setup.py index 747d3f5e186..47af9e362e6 100644 --- a/setup.py +++ b/setup.py @@ -30,7 +30,7 @@ def plotly_js_version(): def readme(): - with open('README.rst') as f: + with open('README.md') as f: return f.read() @@ -394,17 +394,20 @@ def run(self): maintainer='Chris P', maintainer_email='chris@plot.ly', url='https://plot.ly/python/', - description="Python plotting library for collaborative, " - "interactive, publication-quality graphs.", + project_urls={"Github": "https://github.com/plotly/plotly.py"}, + description="An open-source, interactive graphing library for Python", long_description=readme(), + long_description_content_type="text/markdown", classifiers=[ - 'Development Status :: 4 - Beta', + 'Development Status :: 5 - Production/Stable', 'Programming Language :: Python :: 2', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.3', 'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', 'Topic :: Scientific/Engineering :: Visualization', ], license='MIT', From 82708a50cfd46f15ace60f1b5b0132850b266fd1 Mon Sep 17 00:00:00 2001 From: Jon Mease Date: Wed, 10 Apr 2019 18:22:31 -0400 Subject: [PATCH 2/2] Update maintainer --- setup.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index 47af9e362e6..509b6fb397e 100644 --- a/setup.py +++ b/setup.py @@ -391,8 +391,8 @@ def run(self): use_2to3=False, author='Chris P', author_email='chris@plot.ly', - maintainer='Chris P', - maintainer_email='chris@plot.ly', + maintainer='Jon Mease', + maintainer_email='jon@plot.ly', url='https://plot.ly/python/', project_urls={"Github": "https://github.com/plotly/plotly.py"}, description="An open-source, interactive graphing library for Python",