Skip to content

Commit

Permalink
changes for v0.4.3
Browse files Browse the repository at this point in the history
  • Loading branch information
s4w3d0ff authored May 23, 2017
1 parent c85dfe9 commit 0990741
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ Inspired by [this](http://pastebin.com/8fBVpjaj) wrapper written by 'oipminer'
## Install latest release:
Python 2:
```
pip install https://github.com/s4w3d0ff/python-poloniex/archive/v0.4.2.zip
pip install https://github.com/s4w3d0ff/python-poloniex/archive/v0.4.3.zip
```

Python 3:
```
pip3 install https://github.com/s4w3d0ff/python-poloniex/archive/v0.4.2.zip
pip3 install https://github.com/s4w3d0ff/python-poloniex/archive/v0.4.3.zip
```

### Features:
- The first 2 args in the `poloniex.Poloniex` object (`key` and `secret`) are _optional_ when used for _public api commands_.
- Api commands have been 'mapped' into methods within the `Poloniex` class for your convenience.
- Raises `poloniex.PoloniexError` if the command supplied does not exist, if the api keys are not defined and attempting to access a private api command, or if Poloniex.com returns an api error.
- The `poloniex.Poloniex(timeout=1)` attribute/arg adjusts the number of seconds to wait for a response from poloniex, else `requests.exceptions.Timeout` is raised (which will be caught by 'poloniex.retry' and attempt the call again).
- The `poloniex.Poloniex(timeout=80)` attribute/arg adjusts the number of seconds to wait for a response from poloniex, else `requests.exceptions.Timeout` is raised (which will be caught by 'poloniex.retry' and attempt the call again).
- If a `requests` exception is raised (including `Timeout`s), signaling that the api call did not go through, the wrapper will attempt to try the call again. The wait pattern between retrys are as follows (in seconds): (0, 2, 5, 30). Once the retry delay list is exausted and the call still throws an error, the list of captured exceptions is raised.
- A call restrictor (`coach`) is enabled by default, limiting the api wrapper to 6 calls per second. If you wish, you can deactivate the coach using `Poloniex(coach=False)` or use an 'external' coach.
- By default, json floats are parsed as strings (ints are ints), you can define `Poloniex(jsonNums=float)` to have _all numbers_ (floats _and_ ints) parsed as floats (or import and use `decimal.Decimal`).
Expand Down

0 comments on commit 0990741

Please sign in to comment.