.. pstream documentation master file, created by
   sphinx-quickstart on Mon Oct 12 12:01:07 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

PStream: fluent, async, iteration
===================================

.. toctree::
   :maxdepth: 10
   :caption: Contents:

.. image:: https://img.shields.io/pypi/dm/pstream
    :target: https://pepy.tech/project/requests

.. image:: https://img.shields.io/pypi/l/pstream
    :target: https://github.com/christopher-henderson/pstream/blob/main/LICENSE

.. image:: https://img.shields.io/pypi/pyversions/pstream
    :target: https://pypi.org/project/requests/

.. automodule:: pstream
   :members:

.. highlight:: python


:class:`pstream.Stream`
-------------------
A fluent interface for composing lazily evaluated, stream fusion, iterators.

:class:`pstream.AsyncStream`
-------------------
An asynchronous version of the API for a :class:`pstream.Stream`. Asynchronous
(as well as synchronous) iterators and functions may be easily combined into
a single pipeline.


:mod:`pstream.errors`
-------------------


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`