Skip to content

Commit aec89f3

Browse files
committed
Added README info, added self to contributors, bumped version
1 parent 67ba3fe commit aec89f3

File tree

3 files changed

+32
-1
lines changed

3 files changed

+32
-1
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,7 @@ time.sleep(10)
354354
order_book.close()
355355
```
356356

357+
<<<<<<< HEAD
357358
### Testing
358359
Unit tests are under development using the pytest framework. Contributions are
359360
welcome!
@@ -370,6 +371,30 @@ python -m pytest
370371
- Major overhaul on how pagination is handled
371372

372373
*1.0*
374+
=======
375+
### Error Handling
376+
Error handling has been added in version 2.0. Currently, the only HTTP error codes that
377+
are handled are the ones documented on the GDAX API error section: [here](https://docs.gdax.com/?python#errors)
378+
379+
HTTP STATUS CODE 400: Raises InvalidGdaxRequest
380+
HTTP STATUS CODE 401: Raises UnauthorizedGdaxRequest
381+
HTTP STATUS CODE 403: Raises ForbiddenGdaxRequest
382+
HTTP STATUS CODE 404: Raises NotFoundGdaxRequest
383+
HTTP STATUS CODE 4XX: Raises UnknownGDAXClientRequest
384+
HTTP STATUS CODE 5XX: Raises InternalErrorGdaxRequest
385+
386+
All HTTP requests from both the public client and authenticated client run through `_determine_response`, which
387+
either returns the JSON body or raises the appropriate error.
388+
389+
Please consider creating new Exception classes and mapping as Gdax error states are discovered.
390+
391+
392+
## Change Log
393+
*2.0*
394+
- Added error handling to all HTTP requests [Error Handling Docs](#Error Handling)
395+
396+
*1.0* **Current PyPI release**
397+
>>>>>>> Added README info, added self to contributors, bumped version
373398
- The first release that is not backwards compatible
374399
- Refactored to follow PEP 8 Standards
375400
- Improved Documentation

contributors.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ Leonard Lin
33
Jeff Gibson
44
David Caseria
55
Paul Mestemaker
6-
Drew Rice
6+
Drew Rice
7+
Benjamin Ross

setup.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,13 @@
1919
long_description = fh.read()
2020

2121
setup(
22+
<<<<<<< HEAD
2223
name='cbpro',
2324
version='1.1.4',
25+
=======
26+
name='gdax',
27+
version='2.0.0',
28+
>>>>>>> Added README info, added self to contributors, bumped version
2429
author='Daniel Paquin',
2530
author_email='[email protected]',
2631
license='MIT',

0 commit comments

Comments
 (0)