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

Fixed dependency config

Browse Source 
Corrected pyproject.toml by moving appdirs dependency entry from
`[tool.poetry.group.dev.dependencies]` to `[tool.poetry.dependencies]`.

Added license, description, and project URLs to pyproject.toml.

Freshened up README.md
This commit is contained in:
TC Johnson 2024-12-11 20:50:02 -06:00
parent 1387c512ce
commit aeb45a3b0f
3 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
veilid-python/README.md
View File

@ -3,11 +3,10 @@ Create an application in Python using the distributed [Veilid](https://veilid.co
## 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
* Veilid Python makes heavy use of async and other bleeding edge functions requiring Python version >= 3.12.5
## Usage
## Install
To use:
```
poetry add veilid
```
@ -16,18 +15,18 @@ or
pip3 install veilid
```
## Development
To run tests:
```
poetry run pytest
```shell
poetry run pytest -v -s
```
To update schema for validation with the latest copy from a running `veilid-server`:
```
To update schema for validation with the latest copy from a locally running `veilid-server`:
```shell
./update_schema.sh
```
## Basic Veilid App Setup
A demo chat application is available to review [here](https://gitlab.com/veilid/python-demo).

4
veilid-python/poetry.lock generated
View File

@ -1,4 +1,4 @@
# This file is automatically @generated by Poetry 1.8.4 and should not be changed by hand.
# This file is automatically @generated by Poetry 1.8.5 and should not be changed by hand.
[[package]]
name = "appdirs"
@ -373,4 +373,4 @@ files = [
[metadata]
lock-version = "2.0"
python-versions = "^3.12.5"
content-hash = "48fccebf6b6253d7e85eb11a28b384d89f26bfd2b3b9535a68452c6d2968d8d3"
content-hash = "911110698d684d3fa1ae91baf5e107b25008779140bb25892cb59785f2d6654e"

9
veilid-python/pyproject.toml
View File

@ -3,20 +3,25 @@
name = "veilid"
version = "0.4.1"
# ---
description = ""
description = "Create an application in Python using the distributed Veilid framework for private, E2EE, app-to-app communication."
authors = ["Veilid Team <contact@veilid.com>"]
readme = "README.md"
license = "MPL-2.0"
packages = [{ include = "veilid" }]
[tool.poetry.urls]
homepage = "https://veilid.com"
repository = "https://gitlab.com/veilid/veilid"
[tool.poetry.dependencies]
python = "^3.12.5"
jsonschema = "^4.17.3"
appdirs = "^1.4.4"
[tool.poetry.group.dev.dependencies]
pytest = "^7.3.2"
pytest-cov = "^5.0.0"
pytest-asyncio = "^0.21.0"
appdirs = "^1.4.4"
[build-system]
requires = ["poetry-core"]