Git-Mirrors/veilid
1
0
Fork 0
mirror of https://gitlab.com/veilid/veilid.git synced 2024-09-19 23:55:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
fe971fead2
veilid/veilid-python/README.md
TC Johnson 69cb0beb36
Make Python README a bit more descriptive 
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.
2023-09-04 11:07:50 -05:00

833 B
Raw Blame History

Veilid Bindings for Python

Create an application in Python using the distributed Veilid 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
  • Veilid Python makes heavy use of async and other bleeding edge functions requiring Python version >= 3.11.4

Usage

To use:

poetry add veilid

or

pip3 install veilid

Development

To run tests:

poetry run pytest

To update schema for validation with the latest copy from a running veilid-server:

./update_schema.sh

Basic Veilid App Setup

A demo chat application is available to review here.