diff --git a/py/embedded-server/README_PyPi.md b/py/embedded-server/README_PyPi.md new file mode 100644 index 00000000000..88f5c7228b4 --- /dev/null +++ b/py/embedded-server/README_PyPi.md @@ -0,0 +1,29 @@ +# deephaven-server + +A Python-native way of launching [deephaven-core](https://www.github.com/deephaven/deephaven-core). + +Deephaven Community Core is a real-time, time-series, column-oriented analytics engine with relational database features. It is an open version of [Deephaven Enterprise](https://deephaven.io/enterprise/), which serves as the data backbone for prominent hedge funds, banks, and financial exchanges. + +## Requirements + +Java 11+ is required for this module, and the `JAVA_HOME` environment variable must be set appropriately. + +This module also requires Python version 3.7 or newer. + +## Setup + +```shell +pip3 install --upgrade pip setuptools wheel +pip3 install deephaven-server +``` + +## Quick start + +```python +from deephaven_server import Server +server = Server() +server.start() + +from deephaven import time_table +ticking_table = time_table('00:00:01').update_view(formulas=["Col1 = i % 2"]) +``` \ No newline at end of file diff --git a/py/embedded-server/build.gradle b/py/embedded-server/build.gradle index 97aab0df456..d61f6f780ba 100644 --- a/py/embedded-server/build.gradle +++ b/py/embedded-server/build.gradle @@ -8,7 +8,7 @@ configurations { } wheel { contents { - include 'deephaven_server/', 'setup.py', 'README.md' + include 'deephaven_server/', 'setup.py', 'README.md', 'README_PyPi.md' from(configurations.classpath) { include '*' into('deephaven_server/jars') diff --git a/py/embedded-server/setup.py b/py/embedded-server/setup.py index eff7db1dd86..b9283bb0212 100644 --- a/py/embedded-server/setup.py +++ b/py/embedded-server/setup.py @@ -10,7 +10,7 @@ HERE = pathlib.Path(__file__).parent # The text of the README file -README = (HERE / "README.md").read_text() +README = (HERE / "README_PyPi.md").read_text() # Versions should comply with PEP440. For a discussion on single-sourcing