Metadata-Version: 1.1
Name: agent
Version: 0.1.2
Summary: Async generators for humans
Home-page: https://github.com/chrisseto/Agent
Author: Chris Seto
Author-email: chriskseto@gmail.com
License: The MIT License (MIT)

Copyright (c) 2015 Chris Seto

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


Description-Content-Type: UNKNOWN
Description: # Agent: Async generators for humans
        
        **agent** provides a simple decorator to create python 3.5 [asynchronous iterators](https://docs.python.org/3/reference/compound_stmts.html#async-for) via `yield`s
        
        ## Examples
        
        Make people wait for things for no reason!
        ```python
        import agent
        import asyncio
        
        @agent.gen  # Shorthand decorator
        def wait_for_me():
          yield 'Like '
          yield from asyncio.sleep(1)
          yield 'the line '
          yield from asyncio.sleep(10)
          yield 'at '
          yield from asyncio.sleep(100)
          yield 'the DMV'
        
        async for part in wait_for_me():
          print(part)
        ```
        
        Paginate websites in an easy asynchronous manner.
        ```python
        import agent
        import aiohttp
        
        @agent.async_generator
        def gen():
          page, url = 0, 'http://example.com/paginated/endpoint'
          while True:
            resp = yield from aiohttp.request('GET', url, params={'page': page})
            resp_json = (yield from resp.json())['data']
            if not resp_json:
              break
            for blob in resp_json['data']:
              yield blob
            page += 1
        
        # Later on....
        
        async for blob in gen():
            # Do work
        ```
        
        
        **The possibilities are endless!**
        
        For additional, crazier, examples take a look in the [tests directory](tests/).
        
        
        ## Get it
        
        ```bash
        $ pip install -U agent
        ```
        
        ## Caveats
        
        `yield from` syntax must be used as `yield` in an `async def` block is a syntax error.
        
        ```python
        async def generator():
          yield 1  # Syntax Error :(
        ```
        
        `asyncio.Future`s can not be yield directly, they must be wrapped by `agent.Result`.
        
        
        ## License
        
        MIT licensed. See the bundled [LICENSE](LICENSE) file for more details.
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
