Metadata-Version: 2.1
Name: beneath
Version: 1.0.1
Summary: Python client for Beneath (https://beneath.network/)
Home-page: https://gitlab.com/_beneath/beneath-python
Author: Beneath Systems
Author-email: hello@beneath.network
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: apache-beam[gpc] (>=2.14.0)
Requires-Dist: argparse (>=1.1)
Requires-Dist: fastavro (>=0.21.24)
Requires-Dist: grpcio (>=1.23.0)
Requires-Dist: pandas (>=0.24.2)
Requires-Dist: six (>=1.12.0)

# Beneath Python Client Library

This repository contains the source code for the [Beneath](https://beneath.network) Python library. Learn more about it with these resources:

- [Getting started tutorial](https://about.beneath.network/docs)
- [Reading data from Beneath](https://about.beneath.network/docs)
- [Using the command-line interface](https://about.beneath.network/docs)
- [Writing new analytics to Beneath](https://about.beneath.network/docs)

### Providing feedback

Beneath is just entering public beta, so there's bound to be some rough edges. Bugs, feature requests, suggestions – we'd love to hear about them. To file an issue, [click here](https://gitlab.com/_beneath/beneath-python/issues).

### Developing the library

- Make sure Python 3 is installed and available as `python3`
- Initialize and source the Python virtual environment with:

    python3 -m venv .env
    source .env/bin/activate
    pip install -r requirements.txt

- Run tests with `pytest` (though it's sparse on tests at moment)
- Run `deactivate` to exit the virtual environment and `source .env/bin/activate` to re-activate it
- For use in VS Code, open `beneath-python` as a workspace root folder. Press `CMD+Shift+P`, search for `Python: Select Interpreter`, and select the Python 3 executable in the `.env` virtual environment.

### Publishing to PyPI

- Increment the version number in `beneath/_version.py`
- Run `./pypi-publish.sh`
- Make sure to appropriately update configuration of recommended and deprecated versions in `beneath-core/beneath-go/gateway/grpc_server.go`


