Merge pull request #53 from plotly/use-readme-description

Use README as package description

Author: alexshoe

CONTRIBUTING.md

@@ -1,4 +1,21 @@
 # CONTRIBUTING
 
-This project was generated by the [dash-component-boilerplate](https://github.com/plotly/dash-component-boilerplate) it contains the minimal set of code required to create your own custom Dash component.
+## Build manually
+
+To generate builds manually, run the following:
+
+```sh
+$ pip install -r requirements-dev.txt
+$ npm install
+$ npm run build
+```
+
+## Usage
 
+`usage.py` provides you with the basic functionality of the app. Use it to learn the most basic implementation of a Dash Player component.
+
+`usage-methods.py` allows you to test properties that are updated at an interval.
+
+`usage-advanced.py` gives an overview of the full functionality of the component, and serves as an extensive testing tool.
+
+This project was generated by the [dash-component-boilerplate](https://github.com/plotly/dash-component-boilerplate) it contains the minimal set of code required to create your own custom Dash component.

README.md

@@ -14,30 +14,9 @@ This is a custom community component, so if your organization or company is inte
 Here are the following steps to get started with using Dash Player in your own Dash apps
 
 ```sh
-$ git clone https://github.com/plotly/dash-player
-$ cd dash-player
-$ npm install
+$ pip install dash-player
 ```
 
-Once that's done, you can copy the `dash_player` package in the folder of your app, and import it within your app.
-
-## Build manually
-
-To generate builds manually, run the following:
-
-```sh
-$ npm install webpack webpack-cli
-$ npm run build
-```
-
-## Usage
-
-`usage.py` provides you with the basic functionality of the app. Use it to learn the most basic implementation of a Dash Player component.
-
-`usage-methods.py` allows you to test properties that are updated at an interval.
-
-`usage-advanced.py` gives an overview of the full functionality of the component, and serves as an extensive testing tool.
-
 ## Documentation
 
 | Prop                    | Description                                                                                                                                                                       | Default |
@@ -74,9 +53,9 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduc
 
 ## Authors
 
-- **Xing Han** - _Initial Work_ - [@xhlulu](https://github.com/xhlulu)
+- **Xing Han** - _Initial Work_ - [@xhluca](https://github.com/xhluca)
 - **Alex Hsu** - _Maintainer/Ongoing Developer_ - [@alexshoe](https://github.com/alexshoe)
-- **Chris** - _Code Review_
+- **Alex Johnson** - _Code Review_ - [@alexcjohnson](https://github.com/alexcjohnson)
 
 See also the list of [contributors](https://github.com/xhlulu/dash-player/contributors) who participated in this project.
 

setup.py

@@ -1,3 +1,4 @@
+import io
 import json
 import os
 from setuptools import setup
@@ -15,6 +16,16 @@
     packages=[package_name],
     include_package_data=True,
     license=package["license"],
-    description=package["description"] if "description" in package else package_name,
-    install_requires=[],
+    description=("A Dash component for playing a variety of URLs."),
+    long_description=io.open("README.md", encoding="utf-8").read(),
+    long_description_content_type="text/markdown",
+    python_requires=">=3.6",
+    url="https://github.com/plotly/dash-player",
+    install_requires=["dash>=1.6.1"],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "Framework :: Dash",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
 )