mirror of
https://github.com/QuivrHQ/quivr.git
synced 2024-12-14 17:03:29 +03:00
a15c9ec88f
# Description Please include a summary of the changes and the related issue. Please also include relevant motivation and context. ## Checklist before requesting a review Please delete options that are not relevant. - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code |
||
---|---|---|
.. | ||
examples | ||
MegaParse | ||
quivr_core | ||
scripts | ||
tests | ||
.gitignore | ||
.python-version | ||
CHANGELOG.md | ||
Dockerfile.test | ||
pyproject.toml | ||
README.md | ||
tox.ini |
quivr-core package
The RAG of Quivr.com
Contributors
Requirements
- Install poetry. Recommand the
pipx
install - (Optional) Install (
uv
)[https://github.com/astral-sh/uv] - git clone
quivr
git clone git@github.com:QuivrHQ/quivr.git
cd quivr/backend/core
-
Create virtual environement with your preferred tool
uv venv
-
Install
base
quivr-core environmentpoetry install -E base --with dev,test
-
Install pre-commit
pre-commit install
-
Run example
python examples/simple_question.py
Backend
- Install poetry. Recommand the
pipx
install - (Optional) Install (
uv
)[https://github.com/astral-sh/uv] - Clone
quivr
cd quivr/backend/
-
Create virtual environement with your preferred tool
uv venv
-
Install quivr-core monorepo
poetry install
-
Copy
.env.example
to.env
and modify env variables : step 2 : (https://docs.quivr.app/install#60-seconds-installation) -
Run backend-api
LOG_LEVEL=debug uvicorn quivr_api.main:app --log-level debug --reload --host 0.0.0.0 --port 5050 --workers 1