Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add: readme & fix: remove dep #3465

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/backend-core-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,5 @@ jobs:
OPENAI_API_KEY: this-is-a-test-key
run: |
sudo apt-get update
sudo apt-get install -y libmagic-dev poppler-utils libreoffice tesseract-ocr pandoc
cd core
rye test -p quivr-core
6 changes: 0 additions & 6 deletions core/Dockerfile.test
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,6 @@ RUN apt-get clean && apt-get update && apt-get install -y \
autoconf \
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we still need the build system deps ?

automake \
build-essential \
# Additional dependencies for document handling
libmagic-dev \
tesseract-ocr \
poppler-utils \
libreoffice \
pandoc && \
rm -rf /var/lib/apt/lists/*

# Set the working directory
Expand Down
12 changes: 12 additions & 0 deletions core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ This project is licensed under the Apache 2.0 License
pip install quivr-core
```

### Use with [MegaParse](https://github.com/QuivrHQ/MegaParse)

By **default** megaparse-core uses MegaParse to parse files, in order to use it we need to either :

**Use Quivr hosted Megaparse API**
* Send email to **[email protected]** with object : "[Megaparse] API Key Request"
* Add ```MEGAPARSE_API_KEY = md-...``` in your *.env* file

**Use self hosted Megaparse API**
* Clone https://github.com/QuivrHQ/MegaParse
* Run the api with ```make dev``` in ```cd MegaParse```
* Back in quivr-core add ```MEGAPARSE_URL = http://localhost:8000``` in your env variables



1 change: 0 additions & 1 deletion core/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ markers = [
"slow: marks tests as slow (deselect with '-m \"not slow\"')",
"base: these tests require quivr-core with extra `base` to be installed",
"tika: these tests require a tika server to be running",
"unstructured: these tests require `unstructured` dependency",
]

[[tool.mypy.overrides]]
Expand Down
Loading