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 2019/07/03 23:09:29 UTC
[incubator-datasketches-cpp] branch python_readme updated: Update
README.md
This is an automated email from the ASF dual-hosted git repository.
jmalkin pushed a commit to branch python_readme
in repository https://gitbox.apache.org/repos/asf/incubator-datasketches-cpp.git
The following commit(s) were added to refs/heads/python_readme by this push:
new dbaa743 Update README.md
dbaa743 is described below
commit dbaa7431d90470df6dc17f60d08dc31ae9e39966
Author: Jon Malkin <jm...@users.noreply.github.com>
AuthorDate: Wed Jul 3 16:09:25 2019 -0700
Update README.md
---
python/README.md | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/python/README.md b/python/README.md
index e80719f..867aad9 100644
--- a/python/README.md
+++ b/python/README.md
@@ -1,8 +1,22 @@
# Python Wrapper for Datasketches
+## Installation
+
+The easiest way to install the python wrapper is to run
+```pip install git+https://github.com/apache/incubator-datasketches-cpp.git```
+
+If you prefer to downlioad the source first, be sure to clone the repo with `--recursive` to ensure you get the python binding library ([pybind11](https://github.com/pybind/pybind11)):
+```
+git clone --recursive https://github.com/apache/incubator-datasketches-cpp.git
+cd incubator-datasketches-cpp
+pip install .
+```
+
+In the event you do not have `pip` installed, you can invoke the setup script directly by replacing the last line above with `python3 setup.py install`.
+
## Usage
-Having followed installation instructions in the root directory, loading the Datasketches library in Python is simple: `from datasketches import *`.
+Having installed the library, loading the Datasketches library in Python is simple: `from datasketches import *`.
## Available Sketch Classes
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org