Skip to content

docs: add credential-light smoke test #13

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.

Sign up for GitHub

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

Open
SufianTA wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add credential-light smoke test #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,23 @@ uv pip install -e .
uv pip install openai==1.82.1 # Ensure correct OpenAI version
```

### Credential-light smoke test

Before downloading MedeaDB or configuring model-provider credentials, verify that
the package imports correctly in the active environment:

```bash
python - <<'PY'
import medea

print("Medea import OK")
print(medea.__file__)
PY
```

This check is intentionally limited to package import health. Full agent runs
still require `MEDEADB_PATH` and at least one configured LLM provider key.

### Download MedeaDB

Download required datasets from Hugging Face:
Expand Down