Metadata-Version: 2.1
Name: lowhaio
Version: 0.0.58
Summary: Lightweight Python asyncio HTTP/1.1 client. 
Home-page: https://github.com/michalc/lowhaio
Author: Michal Charemza
Author-email: michal@charemza.name
License: UNKNOWN
Description: # lowhaio [![CircleCI](https://circleci.com/gh/michalc/lowhaio.svg?style=svg)](https://circleci.com/gh/michalc/lowhaio) [![Test Coverage](https://api.codeclimate.com/v1/badges/418d72f1de909bff27b6/test_coverage)](https://codeclimate.com/github/michalc/lowhaio/test_coverage)
        
        A lightweight Python asyncio HTTP/1.1 client. No additional tasks are created; all code is in a single module; and other than the standard library only a single dependency is required, [aiodnsresolver](https://github.com/michalc/aiodnsresolver).
        
        Connections are DNS-aware, in that they are only re-used if they match a current A record for the domain.
        
        
        ## Installation
        
        ```bash
        pip install lowhaio
        ```
        
        
        ## Usage
        
        The API is streaming-first: for both request and response bodies, asynchronous iterators are used.
        
        ```python
        import os
        from lowhaio import Pool
        
        request, _ = Pool()
        
        path = 'my.file'
        content_length = str(os.stat(path).st_size).encode()
        async def file_data():
            with open(path, 'rb') as file:
                for chunk in iter(lambda: file.read(16384), b''):
                    yield chunk
        
        code, headers, body = await request(
            b'POST', 'https://example.com/path',
            params=(), headers=((b'content-length': content_length),), body=file_data,
        )
        async for chunk in body:
            print(chunk)
        ```
        
        However, there are helper functions `streamed` and `buffered` when this isn't required or possible.
        
        ```python
        from lowhaio import Pool, streamed, buffered
        
        request, _ = Pool()
        
        content = b'some-data'
        content_length = b'9'
        code, headers, body = await request(
            b'POST', 'https://example.com/path',
            params=(), headers=((b'content-length': content_length),), body=streamed(content),
        )
        
        response = await buffered(body)
        ```
        
        
        ## Headers
        
        The only header automatically added to requests is the `host` header, which is the idna/punycode-encoded domain name from the requested URL.
        
        
        ## Exceptions
        
        Exceptions raised are subclasses of `HttpError`. If a lower-level exception caused this, it is set in the `__cause__` attribute of the `HttpError`
        
        Exceptions before any data is sent are instances of `HttpConnectionError`, and after data is sent, `HttpDataError`. This is to make it possible to know if non-idempotent requests can be retried.
        
        
        ## Scope
        
        The scope of the core functions is restricted to:
        
        - (TLS) connection opening, closing and pooling;
        - passing and receiving HTTP headers and streaming bodies;
        - decoding chunked responses;
        - raising exceptions on timeouts.
        
        This is to make the core behaviour useful to a reasonable range of uses, but to _not_ include what can be added by layer(s) on top. Specifically not included:
        
        - following redirects;
        - [retrying failed requests](https://github.com/michalc/lowhaio-retry);
        - cookies;
        - compressing/decompressing requests/responses;
        - [encoding chunked requests](https://github.com/michalc/lowhaio-chunked);
        - authentication, such as [AWS Signature Version 4](https://github.com/michalc/lowhaio-aws-sigv4).
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Framework :: AsyncIO
Requires-Python: ~=3.6.0
Description-Content-Type: text/markdown
