Merge pull request #335 from VincentRouvreau/gudhi_pip_package

gudhi pip package for version 3.2.0

3 files changed, 45 insertions, 3 deletions

diff --git a/src/python/CMakeLists.txt b/src/python/CMakeLists.txt
index 1e81cac8..81be1b76 100644
--- a/src/python/CMakeLists.txt
+++ b/src/python/CMakeLists.txt
@@ -239,6 +239,9 @@ if(PYTHONINTERP_FOUND)
     file(COPY "gudhi/dtm_rips_complex.py" DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/gudhi")
     file(COPY "gudhi/hera/__init__.py" DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/gudhi/hera")
 
+    # Some files for pip package
+    file(COPY "introduction.rst" DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/")
+
     add_custom_command(
         OUTPUT gudhi.so
         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
diff --git a/src/python/introduction.rst b/src/python/introduction.rst
new file mode 100644
index 00000000..11c06ac5
--- /dev/null
+++ b/src/python/introduction.rst
@@ -0,0 +1,24 @@
+The Gudhi library is an open source library for Computational Topology and
+Topological Data Analysis (TDA). It offers state-of-the-art algorithms
+to construct various types of simplicial complexes, data structures to
+represent them, and algorithms to compute geometric approximations of shapes
+and persistent homology.
+
+The GUDHI library offers the following interoperable modules:
+
+* Complexes:
+   * Cubical
+   * Simplicial: Rips, Witness, Alpha and Čech complexes
+   * Cover: Nerve and Graph induced complexes
+* Data structures and basic operations:
+   * Simplex tree, Skeleton blockers and Toplex map
+   * Construction, update, filtration and simplification
+* Topological descriptors computation
+* Manifold reconstruction
+* Topological descriptors tools:
+   * Bottleneck distance
+   * Statistical tools
+   * Persistence diagram and barcode
+
+For more information about Topological Data Analysis and its workflow, please
+refer to the `Wikipedia TDA dedicated page <https://en.wikipedia.org/wiki/Topological_data_analysis>`_.
diff --git a/src/python/setup.py.in b/src/python/setup.py.in
index 9b3c7521..98d058fc 100644
--- a/src/python/setup.py.in
+++ b/src/python/setup.py.in
@@ -64,14 +64,29 @@ for module in pybind11_modules:
         runtime_library_dirs=runtime_library_dirs,
         ))
 
+# read the contents of introduction.rst
+with open("introduction.rst", "r") as fh:
+    long_description = fh.read()
+
 setup(
     name = 'gudhi',
     packages=find_packages(), # find_namespace_packages(include=["gudhi*"])
     author='GUDHI Editorial Board',
     author_email='gudhi-contact@lists.gforge.inria.fr',
     version='@GUDHI_VERSION@',
-    url='http://gudhi.gforge.inria.fr/',
+    url='https://gudhi.inria.fr/',
+    project_urls={
+        'Bug Tracker': 'https://github.com/GUDHI/gudhi-devel/issues',
+        'Documentation': 'https://gudhi.inria.fr/python/latest/',
+        'Source Code': 'https://github.com/GUDHI/gudhi-devel',
+        'License': 'https://gudhi.inria.fr/licensing/'
+        },
+    description='The Gudhi library is an open source library for ' \
+        'Computational Topology and Topological Data Analysis (TDA).',
+    long_description_content_type='text/x-rst',
+    long_description=long_description,
     ext_modules = ext_modules,
-    install_requires = ['cython','numpy >= 1.9',],
-    setup_requires = ['numpy >= 1.9','pybind11',],
+    install_requires = ['numpy >= 1.9',],
+    setup_requires = ['cython','numpy >= 1.9','pybind11',],
+    package_data={"": ["*.dll"], },
 )