Initial hello world IBKR API connection.
This commit is contained in:
@@ -15,15 +15,24 @@ This repository is at the planning and scaffolding stage. The machine learning m
|
||||
|
||||
## Environment
|
||||
|
||||
Use `mise` to manage Python.
|
||||
Use `mise` to manage Python and `uv` to manage Python packages.
|
||||
|
||||
```sh
|
||||
mise install
|
||||
mise exec -- python --version
|
||||
mise exec -- uv sync
|
||||
mise exec -- uv run python --version
|
||||
```
|
||||
|
||||
The current local Python version is pinned in `.mise.toml`.
|
||||
|
||||
## Dependencies
|
||||
|
||||
Runtime dependencies are declared in `pyproject.toml`.
|
||||
|
||||
- `ib-insync` for the IBKR API connection.
|
||||
- `pandas` for tabular candle data handling.
|
||||
- `pyarrow` for Parquet file support.
|
||||
|
||||
## Trading Safety
|
||||
|
||||
The default target is paper trading. Real trading should only be added later with explicit configuration, clear documentation, and tests around order generation and broker integration.
|
||||
@@ -33,3 +42,7 @@ Do not commit secrets such as IBKR credentials, account identifiers, API tokens,
|
||||
## Documentation
|
||||
|
||||
See [docs/README.md](docs/README.md) for the initial architecture notes and decision log.
|
||||
|
||||
The first data collection design note is [docs/data-fetcher.md](docs/data-fetcher.md).
|
||||
|
||||
Manual test instructions for the IBKR fetcher skeleton are in [docs/manual-test/README.md](docs/manual-test/README.md).
|
||||
|
||||
Reference in New Issue
Block a user