Skip to content

Commit

Permalink
bump to release version (#113)
Browse files Browse the repository at this point in the history
* bump to release version
* add botocore update readme
  • Loading branch information
thehesiod authored Jan 30, 2017
1 parent f3faed4 commit e2ea225
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 4 deletions.
39 changes: 39 additions & 0 deletions BOTOCORE_README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
botocore
========


Background and Implementation
-------------
aiobotocore adds async functionality to botocore by replacing certain critical
methods in botocore classes with async versions. The best way to see how this
works is by working backwards from `AioEndpoint._request`. Because of this tight
integration aiobotocore is typically version locked to a particular release of
botocore.

How to upgrade botocore
-------------
aiobotocore's file names try to match the botocore files they functionally match.
For the most part botocore classes are sub-classed with the majority of the
botocore calls eventually called...however certain methods like
`PageIterator.next_page` had to be re-implemented so watch for changes in those
types of methods.

The best way I've seen to upgrade botocore support is by downloading the sources
of the release of botocore you're trying to upgrade to, and the version
of botocore that aiobotocore is currently locked to and do a folder based file
comparison (tools like DiffMerge are nice). You can then manually apply the
relevant changes to their aiobotocore equivalent(s).

Notable changes we've seen in the past:

* new parameters added
* classes being moved to new files
* bodies of methods being updated

basically your typical code refactoring :)

The Future
-------------
The long term goal is that botocore will implement async functionality directly.
See botocore issue: https://github.com/boto/botocore/issues/458 for details,
tracked in aiobotocore here: https://github.com/aio-libs/aiobotocore/issues/36
6 changes: 3 additions & 3 deletions CHANGES.txt
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
Changes
-------

0.2.0a0 (XXX-XX-XX)
^^^^^^^^^^^^^^^^^
0.2.0 (2017-01-30)
^^^^^^^^^^^^^^^^^^
* add support for proxies (thanks @jjonek)
* remove AioConfig verify_ssl connector_arg as this is handled by the
create_client verify param
* remove AioConfig limit connector_arg as this is now handled by
by the Config max_pool_connections property (note default is 10)
by the Config `max_pool_connections` property (note default is 10)

0.1.1 (2017-01-16)
^^^^^^^^^^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion aiobotocore/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from .session import get_session, AioSession

__version__ = '0.2.0a0'
__version__ = '0.2.0'
(get_session, AioSession) # make pyflakes happy

0 comments on commit e2ea225

Please sign in to comment.