Merge branch 'master' into py3-stopiteration-result

Conflicts:
	effect/do.py

Author: radix

.travis.yml

@@ -7,9 +7,8 @@ python:
     - "3.4"
     - "pypy"
 install:
+    - pip install .
     - pip install -r dev-requirements.txt
-    - pip install six
-    - pip install 'characteristic>=14.0.0'
     - pip install sphinx
 script:
     - make lint

Makefile

@@ -15,4 +15,11 @@ doc:
 	rm -rf docs/build
 	rm -rf docs/source/api
 	cd docs; sphinx-apidoc -e -o source/api ../effect ../setup.py ../examples ../effect/test_*.py
+	rm docs/source/api/modules.rst
+	rm docs/source/api/effect.rst
+	# can't use sed -i on both linux and mac, so...
+	# sed -e 's/Module contents/Core API/' docs/source/api/effect.rst > .effect.rst
+	# mv .effect.rst docs/source/api/effect.rst
+	# sed -e 's/effect package/API docs/' docs/source/api/effect.rst > .effect.rst
+	# mv .effect.rst docs/source/api/effect.rst
 	cd docs; PYTHONPATH=..:$(PYTHONPATH) sphinx-build -W -b html -d build/doctrees source build/html

README.rst

@@ -4,41 +4,35 @@ Effect
 .. image:: https://travis-ci.org/python-effect/effect.svg?branch=master
     :target: https://travis-ci.org/python-effect/effect
 
-Effect is a library for helping you write purely functional code by
-isolating the effects (that is, IO or state manipulation) in your code.
-Documentation is available at https://effect.readthedocs.org/.
-
-.. image:: https://radix.github.io/effect/sigh-defects.png
-    :target: https://twitter.com/extempore2/status/553597279463305218
+Effect is a library for helping you write purely functional code by isolating
+the effects (that is, IO or state manipulation) in your code. Documentation is
+available at https://effect.readthedocs.org/, and its PyPI page is
+https://pypi.python.org/pypi/effect.
 
+It `supports`_ both Python 2.6 and up, and 3.4 and up, as well as PyPy.
 
+.. _`supports`: https://travis-ci.org/python-effect/effect
 
-Status: Alpha
-=============
+You can install it by running ``pip install effect``.
 
-Right now Effect is in alpha, and is likely to change incompatibly. Once it's
-being used in production and the API seems pretty good, a final version will be
-released. Because it's in alpha, ``pip`` requires that you explicitly specify
-the version number when specifying a dependency. This means that you won't
-automatically get upgraded to newer versions that potentially break the API.
-e.g., use `pip install effect==0.1aN`.
+.. image:: https://radix.github.io/effect/sigh-defects.png
+    :target: https://twitter.com/extempore2/status/553597279463305218
 
 
 What Is It?
 ===========
 
-Effect lets you isolate your IO and state-manipulation code, by using a system
-very similar to Haskell's `extensible-effects`_ package. It also has
-similarities to Twisted's Deferred objects.
-
-.. _`extensible-effects`: https://hackage.haskell.org/package/extensible-effects
+Effect lets you isolate your IO and state-manipulation code.
 
 The benefits of this are many: first, the majority of your code can become
 purely functional, leading to easier testing and ability to reason about
 behavior. Also, because it separates the specification of an effect from the
 performance of the effect, there are two more benefits: testing becomes easier
 still, and it's easy to provide alternative implementations of effects.
 
+Effect is somewhat similar to "algebraic effects", as implemented in various
+typed functional programming languages. It also has similarities to Twisted's
+Deferred objects.
 
 Example
 =======
@@ -51,27 +45,27 @@ A very quick example of using Effects:
     from effect import perform, sync_performer, Effect, TypeDispatcher
 
     class ReadLine(object):
-	def __init__(self, prompt):
-	    self.prompt = prompt
+        def __init__(self, prompt):
+            self.prompt = prompt
 
     def get_user_name():
-	return Effect(ReadLine("Enter a candy> "))
+        return Effect(ReadLine("Enter a candy> "))
 
     @sync_performer
     def perform_read_line(dispatcher, readline):
-	return raw_input(readline.prompt)
+        return raw_input(readline.prompt)
 
     def main():
-	effect = get_user_name()
-	effect = effect.on(
-	    success=lambda result: print("I like {} too!".format(result)),
-	    error=lambda e: print("sorry, there was an error. {}".format(e)))
+        effect = get_user_name()
+        effect = effect.on(
+            success=lambda result: print("I like {} too!".format(result)),
+            error=lambda e: print("sorry, there was an error. {}".format(e)))
 
-	dispatcher = TypeDispatcher({ReadLine: perform_read_line})
-	perform(dispatcher, effect)
+        dispatcher = TypeDispatcher({ReadLine: perform_read_line})
+        perform(dispatcher, effect)
 
     if __name__ == '__main__':
-	main()
+        main()
 
 
 ``Effect`` takes what we call an ``intent``, which is any object. The

docs/source/api/effect.rst

@@ -0,0 +1,19 @@
+API documentation
+=================
+
+Core API
+--------
+
+.. automodule:: effect
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Submodules
+----------
+
+.. toctree::
+   :glob:
+
+   api/effect.*