Merge pull request #7 from pyper-dev/docs

fix type hints and update docs

Author: pyper-dev

README.md

@@ -51,7 +51,7 @@ Let's simulate a pipeline that performs a series of transformations on some data
 ```python
 import asyncio
 import time
-import typing
+from typing import AsyncIterable
 
 from pyper import task
 
@@ -76,7 +76,7 @@ def step3(data: int):
     return 2 * data - 1
 
 
-async def print_sum(data: typing.AsyncGenerator[int]):
+async def print_sum(data: AsyncIterable[int]):
     """Print the sum of values from a data stream."""
     total = 0
     async for output in data:
@@ -234,7 +234,7 @@ No-- not every program is asynchronous, so Pyper pipelines are by default synchr
 
 ```python
 import time
-import typing
+from typing import Iterable
 
 from pyper import task
 
@@ -254,7 +254,7 @@ def step3(data: int):
     return 2 * data - 1
 
 
-def print_sum(data: typing.Generator[int]):
+def print_sum(data: Iterable[int]):
     total = 0
     for output in data:
         total += output

docs/src/docs/UserGuide/CombiningPipelines.md

@@ -125,7 +125,7 @@ Consumer functions will, however need to adapt to asynchronous output. For examp
 ```python
 import asyncio
 import json
-from typing import Dict, Iterable
+from typing import AsyncIterable, Dict
 
 from pyper import task
 
@@ -142,7 +142,7 @@ class JsonFileWriter:
     def __init__(self, filepath):
         self.filepath = filepath
 
-    async def __call__(self, data: Iterable[Dict]):
+    async def __call__(self, data: AsyncIterable[Dict]):
         data_list = [row async for row in data]
         with open(self.filepath, 'w', encoding='utf-8') as f:
             json.dump(data_list, f, indent=4)

docs/src/docs/UserGuide/Considerations.md

@@ -12,7 +12,7 @@ permalink: /docs/UserGuide/Considerations
 1. TOC
 {:toc}
 
-## Just Add More Workers?
+## How Many Workers?
 
 Pyper is a framework for concurrent programming, so it is worth discussing in a little more detail what the [concurrency](TaskParameters#concurrency) parameter is doing. Under the hood, this is an integer which determines:
 
@@ -34,7 +34,7 @@ A function with this property is referred as IO-bound, whereas a function that h
 * Sorting and searching
 
 {: .warning}
-Increasing the number of workers for a task does not improve performance if the task is CPU-bound
+Increasing the number of workers for a CPU-bound task does not improve performance
 
 To experiment for yourself, try running the following script with a range of concurrency values. You'll notice that a higher concurrency will in fact decrease performance, due to the overhead of creating threads.
 

docs/src/index.md

@@ -12,6 +12,22 @@ permalink: /
 <p align="center" style="font-size: 1.5em;">
     <em>Concurrent Python made simple</em>
 </p>
+
+<p align="center">
+<a href="https://github.com/pyper-dev/pyper/actions/workflows/test.yml" target="_blank">
+    <img src="https://github.com/pyper-dev/pyper/actions/workflows/test.yml/badge.svg" alt="Test">
+</a>
+<a href="https://coveralls.io/github/pyper-dev/pyper" target="_blank">
+    <img src="https://coveralls.io/repos/github/pyper-dev/pyper/badge.svg" alt="Coverage">
+</a>
+<a href="https://pypi.org/project/python-pyper" target="_blank">
+    <img src="https://img.shields.io/pypi/v/python-pyper?color=%2334D058&label=pypi%20package" alt="Package version">
+</a>
+<a href="https://pypi.org/project/python-pyper" target="_blank">
+    <img src="https://img.shields.io/pypi/pyversions/python-pyper.svg?color=%2334D058" alt="Supported Python versions">
+</a>
+</p>
+
 ---
 
 <br>