[datasketches-cpp] 01/02: clean up long and short descriptions for python package

[jm...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jmalkin pushed a commit to branch py_readme_cleanup
in repository https://gitbox.apache.org/repos/asf/datasketches-cpp.git

commit 845ef0d6305902a5486caa222c30473e042c11d3
Author: Jon Malkin <jm...@users.noreply.github.com>
AuthorDate: Wed Sep 22 16:21:47 2021 -0700

    clean up long and short descriptions for python package
---
 python/README.md | 7 +++++--
 setup.py         | 3 ++-
 2 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/python/README.md b/python/README.md
index 2a2dc87..b6834f1 100644
--- a/python/README.md
+++ b/python/README.md
@@ -1,4 +1,6 @@
-# Python Wrapper for Apache DataSketches
+<img src="https://datasketches.apache.org/img/datasketches-HorizontalColor-1.svg" width="75%" alt="Apache DataSketchs Logo">
+
+# The Apache DataSketches Library for Python
 
 This is the official version of the [Apache DataSketches](https://datasketches.apache.org) Python library.
 
@@ -66,7 +68,8 @@ The only developer-specific instructions relate to running unit tests.
 ### Unit tests
 
 The Python unit tests are run with `tox`. To ensure you have all the needed package, from the package base directory run:
-```
+
+```bash
 python -m pip install --upgrade tox
 tox
 ```
diff --git a/setup.py b/setup.py
index 5d2fe87..fe00380 100644
--- a/setup.py
+++ b/setup.py
@@ -84,10 +84,11 @@ setup(
     version='3.3.0.dev0',
     author='Apache DataSketches Developers',
     author_email='dev@datasketches.apache.org',
-    description='A wrapper for the C++ Apache DataSketches library',
+    description='The Apache DataSketches Library for Python',
     license='Apache License 2.0',
     url='http://datasketches.apache.org',
     long_description=open('python/README.md').read(),
+    long_description_content_type='text/markdown',
     packages=find_packages('python'), # python pacakges only in this dir
     package_dir={'':'python'},
     # may need to add all source paths for sdist packages w/o MANIFEST.in

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org