Skip to content

Commit 1913127

Browse files
committed
updates copilot instructions for agents
1 parent 95a7031 commit 1913127

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,19 @@
44

55
A step-by-step Copilot guide to set up a [Data Library for Python](https://developers.lseg.com/en/api-catalog/lseg-data-platform/lseg-data-library-for-python) development environment with Python and JupyterLab on Windows and macOS.
66

7+
See [README.md](../README.md) for full project context, architecture diagrams, and rate-limit details.
8+
9+
---
10+
11+
## Agent Notes (Key Conventions)
12+
13+
- **Main notebook**: `notebook/ld_notebook_async_gather.ipynb` — the primary working notebook for concurrent async historical pricing requests using `asyncio.gather()`.
14+
- **Credentials**: Copy `notebook/.env.example``notebook/.env` and fill in `LSEG_API_KEY`, `LSEG_MACHINE_ID`, and `LSEG_PASSWORD`. Never commit `.env`.
15+
- **Library version**: `lseg-data==2.1.1` is pinned in `requirements.txt`. Do not upgrade without testing — API behavior may change.
16+
- **Rate limits**: The Data Platform enforces per-account request-per-second limits. HTTP **429** errors mean too many concurrent requests — reduce concurrency and retry. See [README.md](../README.md) for details.
17+
- **Logging**: `notebook/lseg-data.config.json` controls Data Library logging. File and console logging are disabled by default; enable them there for debugging.
18+
- **Virtual environment**: Always use `.venv` at the workspace root. Never install packages globally.
19+
720
## Prerequisites
821

922
- Python 3.11 or higher installed and available on your `PATH`

0 commit comments

Comments
 (0)