PyLimeRPC/examples/README.md

21 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

# Examples
Three minimal scripts that use `pylimerpc` the way the three
application types will. Each reads its config from `.env` and runs directly
from the repo (no `pip install -e .` needed):
| script | application model | run |
|---|---|---|
| `example_cron_export.py` | cron/URL-triggered data task | `python examples/example_cron_export.py --sid 12345 --out output/cron` |
| `example_cli.py` | distributable CLI admin tool | `python examples/example_cli.py surveys` / `export --sid 12345 --out export.csv` / `tokens-list --sid 12345` |
| `example_asgi.py` | web dashboard via ASGI router | `app` is a plain-ASGI callable; dev: `uvicorn examples.example_asgi:app --port 8000` |
See the **Prerequisites** section in the main `README.md` for what you need before
running these scripts (Python >= 3.10, a LimeSurvey 7 instance with the
RemoteControl API enabled, an RPC user account, and a filled-in `.env`).
Config: `.env` in the repo root (`LIMESURVEY_BASE_URL`, `LIMESURVEY_USERNAME`,
`LIMESURVEY_PASSWORD`, optional `LIMESURVEY_TIMEOUT_SECONDS`, `LIMESURVEY_VERIFY_SSL`).
Generated exports (`output/`, `survey_*_responses.*`, `survey_*_statistics.*`,
`*.csv`/`*.xls`/`*.xlsx`/`*.spss`) are gitignored — survey data is never synced.