Metadata-Version: 2.0
Name: treq
Version: 17.3.1
Summary: A requests-like API built on top of twisted.web's Agent
Home-page: https://github.com/twisted/treq
Author: Amber Brown
Author-email: hawkowl@twistedmatrix.com
License: MIT/X
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Framework :: Twisted
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Dist: incremental
Requires-Dist: requests (>=2.1.0)
Requires-Dist: six
Requires-Dist: Twisted[tls] (>=16.4.0)
Requires-Dist: attrs
Provides-Extra: dev
Requires-Dist: pyflakes; extra == 'dev'
Requires-Dist: pep8; extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: mock (==1.0.1); extra == 'dev'

treq
====

|pypi|_
|build|_
|coverage|_

``treq`` is an HTTP library inspired by
`requests <http://www.python-requests.org>`_ but written on top of
`Twisted <http://www.twistedmatrix.com>`_'s
`Agents <http://twistedmatrix.com/documents/current/api/twisted.web.client.Agent.html>`_.

It provides a simple, higher level API for making HTTP requests when
using Twisted.

.. code-block:: python

    >>> from treq import get

    >>> def done(response):
    ...     print response.code
    ...     reactor.stop()

    >>> get("http://www.github.com").addCallback(done)

    >>> from twisted.internet import reactor
    >>> reactor.run()
    200

For more info `read the docs <http://treq.readthedocs.org>`_.

Contribute
==========

``treq`` is hosted on `GitHub <http://github.com/twisted/treq>`_.

Feel free to fork and send contributions over.

Developing
==========

Install dependencies:

::

    pip install treq[dev]

Run Tests (unit & integration):

::

    trial treq

Lint:

::

    pep8 treq
    pyflakes treq

Build docs::

    tox -e docs

.. |build| image:: https://api.travis-ci.org/twisted/treq.svg?branch=master
.. _build: https://travis-ci.org/twisted/treq

.. |coverage| image:: https://codecov.io/github/twisted/treq/coverage.svg?branch=master
.. _coverage: https://codecov.io/github/twisted/treq

.. |pypi| image:: https://img.shields.io/pypi/v/treq.svg
.. _pypi: https://pypi.python.org/pypi/treq