Metadata-Version: 2.1
Name: beneath
Version: 1.1.5
Summary: Python client for Beneath (https://beneath.dev/)
Home-page: https://gitlab.com/_beneath/beneath-core/-/tree/master/clients/python
Author: Beneath Systems
Author-email: hello@beneath.dev
License: UNKNOWN
Description: # Beneath Python Client Library
        
        [![PyPI version](https://img.shields.io/pypi/v/beneath.svg)](https://pypi.org/project/beneath)
        <!-- [![Docs badge](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://pypi.org/project/beneath) -->
        [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE)
        [![Netlify Status](https://api.netlify.com/api/v1/badges/e2dacc5a-486e-4043-9a42-350acb658efc/deploy-status)](https://app.netlify.com/sites/beneath-clients-python/deploys)
        
        This repository contains the source code for the [Beneath](https://beneath.dev) Python library. Learn more about it with these resources:
        
        - [Overview](https://about.beneath.dev/docs/overview/)
        - [Reading data from Beneath](https://about.beneath.dev/docs/read-data-into-jupyter-notebook/)
        - [Writing data to Beneath](https://about.beneath.dev/docs/write-data-from-your-app/)
        
        ### 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 .venv
            source .venv/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 `python` as a workspace root folder. Press `CMD+Shift+P`, search for `Python: Select Interpreter`, and select the Python 3 executable in the `.venv` virtual environment.
        
        Here are some good resources to understand how Python packages work:
        
        - [Packaging Python Projects](https://packaging.python.org/tutorials/packaging-projects/). It describes how to upload packages to PyPI.
        - [Command Line Scripts](https://python-packaging.readthedocs.io/en/latest/command-line-scripts.html). It describes how to include command-line scripts in Python packages.
        
        ### Publishing to PyPI
        
        - Increment the version number in `beneath/_version.py`
        - Run `./tools/pypi-publish.sh`
        - Make sure to appropriately update configuration of recommended and deprecated versions in `beneath/gateway/grpc/client_version.go`
        
        
        
        <!-- TODO
        
        https://www.npmjs.com/package/beneath
        
        Intro
        
        PYTHON USE CASES
        - Load into Jupyter
        - Query from web server API
        - Write from web server API
        - Running model and saving results
        
        Combines a CLI and a python library. Based on Asyncio and requires Python X+.
        
        Quick start
        - In jupyter
        - In code
        
        Creating a client
        - Authentication options
        
        Reading from a stream
        
        Writing to a stream
        
        Admin functionality
        - recommend CLI
        
        -->
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Provides-Extra: beam
