summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Estabrook <jestabro@vyos.io>2023-08-04 13:37:09 -0500
committerJohn Estabrook <jestabro@vyos.io>2023-08-04 13:37:09 -0500
commit92ce458b4ea9e1dc2ce1df1acc5dc9143134992e (patch)
treef2f563074ca0e0a92ca865efe70720dce4611480
parentfbc1456a812e6e853b619929a9cf85a3b2bb33ae (diff)
downloadvyos-http-api-tools-92ce458b4ea9e1dc2ce1df1acc5dc9143134992e.tar.gz
vyos-http-api-tools-92ce458b4ea9e1dc2ce1df1acc5dc9143134992e.zip
update README
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index c324a7b..b2d8066 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,10 @@
# vyos-http-api-tools
-Debian files for wrapping FastAPI and supporting tools as a deb package, using dh_virtualenv
+Debian files for wrapping FastAPI and supporting tools as a deb package,
+using dh_virtualenv
+
+This is a dependency of vyos-1x; maintaining it as a separate package, for
+now, allows tools that are not yet available in the Debian distros and quick
+updating for bugs/security fixes.
To build:
@@ -9,3 +14,14 @@ To update dependency versions from un-versioned packages names:
(Install pip-compile from 'pip-tools')
pip-compile requirements.in > requirements.txt
+
+Main packages, not including dependencies; cf. requirements.txt:
+
+FastAPI
+https://github.com/tiangolo/fastapi
+Uvicorn
+https://github.com/encode/uvicorn
+Ariadne
+https://github.com/mirumee/ariadne
+makefun
+https://github.com/smarie/python-makefun