Git-Mirrors/veilid
1
0
Fork 0
mirror of https://gitlab.com/veilid/veilid.git synced 2024-10-01 01:26:08 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'enhance-python-readme' into 'main'

Browse Source 
Make Python README a bit more descriptive

See merge request veilid/veilid!172
This commit is contained in:
TC 2023-09-04 16:19:12 +00:00
commit 3502fb8385
No known key found for this signature in database
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
veilid-python/README.md
View File

@ -1,4 +1,9 @@
# 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
## Usage
@ -23,3 +28,6 @@ To update schema for validation with the latest copy from a running `veilid-serv
```
./update_schema.sh
```
## Basic Veilid App Setup
A demo chat application is available to review [here](https://gitlab.com/veilid/python-demo).