Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,6 @@ ib_async.egg-info
poetry.lock
*.csv
*.json
proto/*
**/__pycache__/
#pythonclient/*
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -496,26 +496,39 @@ poetry run ruff format
poetry run ruff check --fix
```

### Generate protobuf dependencies

Build protobuf files

Copy `*.proto` files from `twsapi` into `ib_async/proto`, then run:

```bash
poetry run python -m grpc_tools.protoc -I=proto --python_out=ib_async/protobuf --pyi_out=ib_async/protobuf proto/*.proto
#
poetry run python scripts/fix_proto_imports.py
```

### Local Development

1. Clone the repository:

```bash
git clone https://github.com/ib-api-reloaded/ib_async.git
cd ib_async
```

2. Install dependencies:
1. Install dependencies:
```bash
poetry install --with=dev,docs
```

3. Make your changes and run tests:
1. Make your changes and run tests:
```bash
poetry run pytest
poetry run mypy ib_async
```

4. Submit a pull request with:
1. Submit a pull request with:
- Clear description of changes
- Tests for new functionality
- Updated documentation if needed
Expand Down
Loading
Loading