Metadata-Version: 2.1
Name: pydeephaven
Version: 0.4.1
Summary: The Deephaven Python Client
Home-page: https://deephaven.io/
Author: Deephaven Data Labs
Author-email: python@deephaven.io
License: Deephaven Community License Agreement Version 1.0
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >3.7
Description-Content-Type: text/markdown
Requires-Dist: pyarrow
Requires-Dist: bitstring
Requires-Dist: grpcio
Requires-Dist: protobuf


# Deephaven Python Client 

Deephaven Python Client is a Python package created by Deephaven Data Labs. It is a client API that allows Python applications to remotely access Deephaven data servers.

## Source Directory

### From the deephaven-core repository root 
(clone from https://github.com/deephaven/deephaven-core)
``` shell
$ cd pyclient
```
## Dev environment setup
``` shell
$ pip3 install -r requirements.txt
```

## Build
``` shell
$ python3 setup.py bdist_wheel
```
## Run tests
``` shell
$ python3 -m unittest discover tests
```
## Install
``` shell
$ pip3 install dist/pydeephaven-0.4.1-py3-none-any.whl
```
## Quick start

```python    
    >>> from pydeephaven import Session
    >>> session = Session() # assuming Deephaven Community Edition is running locally with the default configuration
    >>> table1 = session.time_table(period=1000000).update(column_specs=["Col1 = i % 2"])
    >>> df = table1.snapshot().to_pandas()
    >>> print(df)
                        Timestamp  Col1
    0     1629681525690000000     0
    1     1629681525700000000     1
    2     1629681525710000000     0
    3     1629681525720000000     1
    4     1629681525730000000     0
    ...                   ...   ...
    1498  1629681540670000000     0
    1499  1629681540680000000     1
    1500  1629681540690000000     0
    1501  1629681540700000000     1
    1502  1629681540710000000     0

    >>> session.close()

```

## Related documentation
* https://deephaven.io/
* https://arrow.apache.org/docs/python/index.html

## API Reference
[start here] https://deephaven.io/core/docs/clientapis/python


