Skip to content
This repository has been archived by the owner on Jan 5, 2021. It is now read-only.

Commit

Permalink
updated readme and factored out changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
fzumstein committed Oct 19, 2016
1 parent b65e0e2 commit 05e7321
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 128 deletions.
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# IbPy - Interactive Brokers Python API

## What is IbPy?

IbPy is a third-party implementation of the API used for accessing the
Interactive Brokers online trading system. IbPy implements functionality that
the Python programmer can use to connect to IB, request stock ticker data,
submit orders for stocks and futures, and more.

## Installation

There is a package maintained on PyPI under the name IbPy2, it's version is in sync
with the tags on GitHub.

```
pip install IbPy2
```

Alternatively, it can be installed from source. From within the IbPy directory, execute:

```
python setup.py install
```

Pip also supports installing directly from GitHub, e.g. if you want commit `83b9d08ed9c850d840a6700d0fb9c3ca164f9bff`, use

```
pip install git+https://github.com/blampe/IbPy@83b9d08ed9c850d840a6700d0fb9c3ca164f9bff
```

## How do I use IbPy?

See the IbPy wiki page https://github.com/blampe/IbPy/wiki/Getting-Started

## What are the requirements?

* Python >2.5 or >3.3. Previous versions are not supported.
* Either a running instance of Trader Workstation (TWS) or IB Gateway.

## License

IbPy is distributed under the New BSD License. See the LICENSE file in the
release for details.

## Note

IbPy is not a product of Interactive Brokers, nor is this project affiliated
with IB.

## Source code

https://github.com/blampe/IbPy
128 changes: 0 additions & 128 deletions README.mkd

This file was deleted.

15 changes: 15 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# v0.8.0

* Some internal reorganization
* Made available as IbPy2 in PyPI

# Pre v0.8.0

* TWS API version 9.70 now supported
* Over 60% test coverage and growing
* Fixed outstanding bugs in EReader generated source
* Module ib.opt.logger moved to ib.lib.logger
* Class ib.opt.Connection moved to new ib.opt.connection module
* Added script to filter TWS log files; see `demo/log_filter`
* Added ib.sym package to hold various symbolic constants
* Many small enhancements to ib.opt package

0 comments on commit 05e7321

Please sign in to comment.