veilid/veilid-python/README.md

33 lines
833 B
Markdown
Raw Normal View History

2023-06-11 21:41:13 -04:00
# Veilid Bindings for Python
Create an application in Python using the distributed [Veilid](https://veilid.com) framework for app-to-app communication.
## Prerequisites
* A headless Veilid node must be installed on the same host as the Python application. Install instructions can be found [here](https://gitlab.com/veilid/veilid/-/blob/main/INSTALL.md)
* Veilid Python makes heavy use of async and other bleeding edge functions requiring Python version >= 3.11.4
2023-06-11 21:41:13 -04:00
## Usage
To use:
```
poetry add veilid
2023-06-11 21:41:13 -04:00
```
or
```
pip3 install veilid
2023-06-11 21:41:13 -04:00
```
## Development
2023-06-14 16:33:14 -04:00
To run tests:
```
poetry run pytest
```
To update schema for validation with the latest copy from a running `veilid-server`:
2023-06-11 21:41:13 -04:00
```
./update_schema.sh
```
## Basic Veilid App Setup
A demo chat application is available to review [here](https://gitlab.com/veilid/python-demo).