veilid/veilid-python/README.md

# 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

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](https://gitlab.com/veilid/python-demo).
python work 2023-06-12 01:41:13 +00:00			`# Veilid Bindings for Python`
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 16:07:50 +00:00			`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`
python work 2023-06-12 01:41:13 +00:00
			`## Usage`

			`To use:`
			```
Fix Python Install Instructions Changed the references from veilid_python to veilid to match the package name as it is in Pypi. 2023-08-19 00:59:44 +00:00			`poetry add veilid`
python work 2023-06-12 01:41:13 +00:00			```
			`or`
			```
Fix Python Install Instructions Changed the references from veilid_python to veilid to match the package name as it is in Pypi. 2023-08-19 00:59:44 +00:00			`pip3 install veilid`
python work 2023-06-12 01:41:13 +00:00			```


			`## Development`

python work 2023-06-14 20:33:14 +00:00			`To run tests:`
			```
			`poetry run pytest`
			```

			To update schema for validation with the latest copy from a running `veilid-server`:
python work 2023-06-12 01:41:13 +00:00			```
			`./update_schema.sh`
			```
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 16:07:50 +00:00
			`## Basic Veilid App Setup`
			`A demo chat application is available to review [here](https://gitlab.com/veilid/python-demo).`