You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datasketches.apache.org by jm...@apache.org on 2021/09/22 23:48:45 UTC
[datasketches-cpp] branch py_readme_cleanup created (now b3964ea)
This is an automated email from the ASF dual-hosted git repository.
jmalkin pushed a change to branch py_readme_cleanup
in repository https://gitbox.apache.org/repos/asf/datasketches-cpp.git.
at b3964ea use logo with trademark icons, no need to caveat maybe-not-yet for pypi
This branch includes the following new commits:
new 845ef0d clean up long and short descriptions for python package
new b3964ea use logo with trademark icons, no need to caveat maybe-not-yet for pypi
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org
[datasketches-cpp] 02/02: use logo with trademark icons,
no need to caveat maybe-not-yet for pypi
Posted by 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 b3964eaa5e0e11bba74ca1763d3fe6026d6e7580
Author: Jon Malkin <jm...@users.noreply.github.com>
AuthorDate: Wed Sep 22 16:48:23 2021 -0700
use logo with trademark icons, no need to caveat maybe-not-yet for pypi
---
python/README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/python/README.md b/python/README.md
index b6834f1..86d1818 100644
--- a/python/README.md
+++ b/python/README.md
@@ -1,4 +1,4 @@
-<img src="https://datasketches.apache.org/img/datasketches-HorizontalColor-1.svg" width="75%" alt="Apache DataSketchs Logo">
+<img src="https://raw.githubusercontent.com/apache/datasketches-website/master/logos/svg/datasketches-HorizontalColor-TM.svg" width="75%" alt="Apache DataSketchs Logo">
# The Apache DataSketches Library for Python
@@ -16,7 +16,7 @@ Once cloned, the library can be installed by running `python -m pip install .` i
If you prefer to call the `setup.py` build script directly, you must first install `pybind11[global]`, as well as any other dependencies listed under the build-system section in `pyproject.toml`.
-The library is also available (or soon will be) from PyPI via `python -m pip install datasketches`.
+The library is also available from PyPI via `python -m pip install datasketches`.
## Usage
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org
[datasketches-cpp] 01/02: clean up long and short descriptions for
python package
Posted by 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