Skip to content

Add AGENTS.md with Cursor Cloud development instructions #1

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

Draft
dlpe wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add AGENTS.md with Cursor Cloud development instructions #1

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
19 changes: 19 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# AGENTS.md

## Cursor Cloud specific instructions

**pygentix** is a pure Python library (no web app, no Docker, no external services needed for dev/test).

### Quick reference

- **Install**: `pip install -e ".[dev]"` (installs all backends + pytest + pymupdf)
- **Test**: `pytest` (runs 200+ unit tests using `MockAgent` and in-memory SQLite; no API keys needed)
- **Lint**: No linter is configured in the repo. Standard `pyright` or `mypy` can be used if desired.
- **Build**: `python -m build` (pure-Python wheel, setuptools backend)

### Key notes

- The test suite is fully self-contained: it uses `MockAgent` (from `pygentix.testing`) and `sqlite:///:memory:`, so no Ollama server or cloud API keys are required.
- 17 tests are skipped by design — they are integration tests requiring a live Ollama server (`test_integration.py`, `test_vision.py`). This is expected and not a failure.
- Source code lives in `src/pygentix/`; tests live in `tests/`.
- The package is installed in editable mode (`-e`), so code changes are picked up immediately without reinstalling.