veilid/veilid-python
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
..
tests Run Black on veilid-python 2023-08-02 12:28:05 -07:00
veilid changelog for 0.2.1 2023-09-03 17:29:11 -04:00
.gitignore
LICENSE.md
poetry_install.sh
poetry.lock
poetry.toml
pyproject.toml Version update: v0.2.0 → v0.2.1 2023-09-03 19:45:12 -05:00
README.md Make Python README a bit more descriptive 2023-09-04 11:07:50 -05:00
update_schema.sh

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.