fix some examples, use readme as long description

scikit-tda · Apr 13, 2018 · 35ce5b4 · 35ce5b4
1 parent 9915ecb
commit 35ce5b4
Show file tree

Hide file tree

Showing 4 changed files with 597 additions and 105 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,2 +1,3 @@
 recursive-include kmapper/templates *
 recursive-include kmapper/static *
+include README.md
diff --git a/examples/breast-cancer/breast-cancer.html b/examples/breast-cancer/breast-cancer.html
diff --git a/examples/breast-cancer/breast-cancer.py b/examples/breast-cancer/breast-cancer.py
@@ -42,5 +42,4 @@
 mapper.visualize(graph,
                  path_html="breast-cancer.html",
                  title="Wisconsin Breast Cancer Dataset",
-                 custom_tooltips=y,
-                 color_function="average_signal_cluster")
+                 custom_tooltips=y)
diff --git a/setup.py b/setup.py
@@ -2,16 +2,14 @@
 
 from setuptools import setup
 
+with open('README.md') as f:
+    long_description = f.read()
+
 setup(name='kmapper',
       version='1.1.3',
       description='Python implementation of Mapper algorithm for Topological Data Analysis.',
-      long_description="""
-This is a Python implementation of the TDA Mapper algorithm for visualization of high-dimensional data. For complete documentation, see https://MLWave.github.io/kepler-mapper.
-
-KeplerMapper employs approaches based on the Mapper algorithm (Singh et al.) as first described in the paper "Topological Methods for the Analysis of High Dimensional Data Sets and 3D Object Recognition".
-
-KeplerMapper can make use of Scikit-Learn API compatible cluster and scaling algorithms.
-""",
+      long_description=long_description,
+      long_description_content_type="text/markdown",	
       author='HJ van Veen, Nathaniel Saul',
       author_email='info@mlwave.com, nat@saulgill.com',
       url='https://MLWave.github.io/kepler-mapper',