lingyuzeng/sqlmodel-pg-kit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update AGENTS.md with complete examples, notebooks, and env var documentation

Browse Source
This commit is contained in:
lingyuzeng
2026-02-28 17:47:18 +08:00
parent b3bf8f94f8
commit 4e7f592fd7
1 changed files with 21 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
AGENTS.md
View File

@@ -57,6 +57,17 @@ make test-pg-once
- `examples/04_async_crud.py` - Async CRUD operations
- `examples/05_cheminformatics.py` - Cheminformatics use case
- `examples/06_csv_to_sqlmodel.py` - CSV import workflow
- `examples/07_postgres_minimal.py` - Minimal Postgres workflow with REST-style operations
### Notebooks
- `notebooks/01_cheminformatics_quickstart.ipynb` - End-to-end cheminformatics tutorial
- `notebooks/01_sync_crud.ipynb` - Sync CRUD tutorial
- `notebooks/02_bulk_and_filters.ipynb` - Bulk insert and filtering
- `notebooks/03_relationships.ipynb` - Model relationships
- `notebooks/04_async_crud.ipynb` - Async CRUD operations
- `notebooks/05_cheminformatics.ipynb` - Cheminformatics step-by-step
- `notebooks/06_csv_import.ipynb` - CSV import workflow
- `notebooks/07_postgres_minimal.ipynb` - Postgres minimal example
### Tests
- `tests/test_smoke.py` - Fast SQLite tests
@@ -74,13 +85,15 @@ make db-logs # View logs
Environment variables (for Postgres):
```bash
export SQL_HOST=127.0.0.1
export SQL_PORT=5432
export SQL_PORT=5433 # or 5432 for native Postgres
export SQL_USER=postgres
export SQL_PASSWORD=change-me-strong
export SQL_DATABASE=appdb
export SQL_SSLMODE=disable
```
Note: The project supports both `SQL_*` and `PG*` environment variables (e.g., `PGHOST`, `PGPORT`, `PGUSER`, `PGPASSWORD`, `PGDATABASE`). Docker Compose uses port `5433` mapped from container's `5432`.
## Common Workflows
### Adding a new CRUD operation
@@ -101,9 +114,12 @@ make examples
## Build and Package
### PyPI
- Build: `uv build`
- Publish to PyPI: `uv publish`
- Build conda package: `conda build conda/`
- Publish: `uv publish`
### Conda
- Build conda package: `conda build conda/` (if conda recipe exists)
## Important Notes
@@ -111,3 +127,5 @@ make examples
- Postgres is recommended for production and integration tests
- The project uses `uv` for dependency management (PEP 621/517)
- All SQLModel models are registered in `SQLModel.metadata` for `create_all()`
- For production, prefer `sslmode=verify-full` and least-privileged DB users
- Bring your own Alembic migrations; set `target_metadata = SQLModel.metadata` in env.py