Git-Mirrors/veilid
1
0
Fork 0
mirror of https://gitlab.com/veilid/veilid.git synced 2024-12-24 06:49:38 -05:00
Code Issues Packages Projects Releases Wiki Activity

Make Python README a bit more descriptive

Browse Source 
Adding in a little more text to help the reader better understand
what this module is, its prereqs, and point to the demo app as
an example how an app is structured.
This commit is contained in:
TC Johnson 2023-09-04 11:07:50 -05:00
parent b931a5b87e
commit 69cb0beb36
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).