Make README.rst a real file, and docs/index.rst a link instead
Issue #37 reports at least one user having problems the other way around, on Windows 7 32bit
This commit is contained in:
meejah
parent
cb8f851fbf
commit
932ad91020
@ -1 +0,0 @@
|
||||
docs/index.rst
|
||||
79
README.rst
Normal file
79
README.rst
Normal file
@ -0,0 +1,79 @@
|
||||
txaio
|
||||
=====
|
||||
|
||||
| |Version| |Downloads| |Build Status| |Coverage| |Docs|
|
||||
|
||||
--------------
|
||||
|
||||
**txaio** is a helper library for writing code that runs unmodified on
|
||||
both `Twisted <https://twistedmatrix.com/>`_ and `asyncio <https://docs.python.org/3/library/asyncio.html>`_ / `Trollius <http://trollius.readthedocs.org/en/latest/index.html>`_.
|
||||
|
||||
This is like `six <http://pythonhosted.org/six/>`_, but for wrapping
|
||||
over differences between Twisted and asyncio so one can write code
|
||||
that runs unmodified on both (aka *source code compatibility*). In
|
||||
other words: your *users* can choose if they want asyncio **or** Twisted
|
||||
as a dependency.
|
||||
|
||||
Note that, with this approach, user code **runs under the native event
|
||||
loop of either Twisted or asyncio**. This is different from attaching
|
||||
either one's event loop to the other using some event loop adapter.
|
||||
|
||||
|
||||
Platform support
|
||||
----------------
|
||||
|
||||
**txaio** runs on CPython 2.6+ and PyPy 2, on top of Twisted or asyncio. Specifically, **txaio** is tested on the following platforms:
|
||||
|
||||
* CPython 2.6 on Twisted 12.1, 13.2, 15.4 and Trollius 2.0
|
||||
* CPython 2.7 on Twisted 12.1, 13.2, 15.4, trunk and Trollius 2.0
|
||||
* CPython 3.3 on Twisted 15.4, trunk and Trollius 2.0
|
||||
* CPython 3.4 on Twisted 15.4, trunk and asyncio (stdlib)
|
||||
* PyPy 2.5 on Twisted 12.1, 13.2, 15.4, trunk and Trollius 2.0
|
||||
|
||||
|
||||
How it works
|
||||
------------
|
||||
|
||||
Instead of directly importing, instantiating and using ``Deferred``
|
||||
(for Twisted) or ``Future`` (for asyncio) objects, **txaio** provides
|
||||
helper-functions to do that for you, as well as associated things like
|
||||
adding callbacks or errbacks.
|
||||
|
||||
This obviously changes the style of your code, but then you can choose
|
||||
at runtime (or import time) which underlying event-loop to use. This
|
||||
means you can write **one** code-base that can run on Twisted *or*
|
||||
asyncio (without a Twisted dependency) as you or your users see fit.
|
||||
|
||||
Code like the following can then run on *either* system:
|
||||
|
||||
.. sourcecode:: python
|
||||
|
||||
f0 = txaio.create_future()
|
||||
f1 = txaio.as_future(some_func, 1, 2, key='word')
|
||||
txaio.add_callbacks(f0, callback, errback)
|
||||
txaio.add_callbacks(f1, callback, errback)
|
||||
# ...
|
||||
txaio.resolve(f0, "value")
|
||||
txaio.reject(f1, RuntimeError("it failed"))
|
||||
|
||||
|
||||
.. |Version| image:: https://img.shields.io/pypi/v/txaio.svg
|
||||
:target: https://pypi.python.org/pypi/txaio
|
||||
|
||||
.. |Downloads| image:: https://img.shields.io/pypi/dm/txaio.svg
|
||||
:target: https://pypi.python.org/pypi/txaio
|
||||
|
||||
.. |GitHub Stars| image:: https://img.shields.io/github/stars/crossbario/txaio.svg?style=social&label=Star
|
||||
:target: https://github.com/crossbario/txaio
|
||||
|
||||
.. |Master Branch| image:: https://img.shields.io/badge/branch-master-orange.svg
|
||||
:target: https://travis-ci.org/crossbario/txaio.svg?branch=master
|
||||
|
||||
.. |Build Status| image:: https://travis-ci.org/crossbario/txaio.svg?branch=master
|
||||
:target: https://travis-ci.org/crossbario/txaio
|
||||
|
||||
.. |Coverage| image:: https://img.shields.io/codecov/c/github/crossbario/txaio/master.svg
|
||||
:target: https://codecov.io/github/crossbario/txaio
|
||||
|
||||
.. |Docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
|
||||
:target: http://txaio.readthedocs.org/en/latest/
|
||||
@ -1,79 +0,0 @@
|
||||
txaio
|
||||
=====
|
||||
|
||||
| |Version| |Downloads| |Build Status| |Coverage| |Docs|
|
||||
|
||||
--------------
|
||||
|
||||
**txaio** is a helper library for writing code that runs unmodified on
|
||||
both `Twisted <https://twistedmatrix.com/>`_ and `asyncio <https://docs.python.org/3/library/asyncio.html>`_ / `Trollius <http://trollius.readthedocs.org/en/latest/index.html>`_.
|
||||
|
||||
This is like `six <http://pythonhosted.org/six/>`_, but for wrapping
|
||||
over differences between Twisted and asyncio so one can write code
|
||||
that runs unmodified on both (aka *source code compatibility*). In
|
||||
other words: your *users* can choose if they want asyncio **or** Twisted
|
||||
as a dependency.
|
||||
|
||||
Note that, with this approach, user code **runs under the native event
|
||||
loop of either Twisted or asyncio**. This is different from attaching
|
||||
either one's event loop to the other using some event loop adapter.
|
||||
|
||||
|
||||
Platform support
|
||||
----------------
|
||||
|
||||
**txaio** runs on CPython 2.6+ and PyPy 2, on top of Twisted or asyncio. Specifically, **txaio** is tested on the following platforms:
|
||||
|
||||
* CPython 2.6 on Twisted 12.1, 13.2, 15.4 and Trollius 2.0
|
||||
* CPython 2.7 on Twisted 12.1, 13.2, 15.4, trunk and Trollius 2.0
|
||||
* CPython 3.3 on Twisted 15.4, trunk and Trollius 2.0
|
||||
* CPython 3.4 on Twisted 15.4, trunk and asyncio (stdlib)
|
||||
* PyPy 2.5 on Twisted 12.1, 13.2, 15.4, trunk and Trollius 2.0
|
||||
|
||||
|
||||
How it works
|
||||
------------
|
||||
|
||||
Instead of directly importing, instantiating and using ``Deferred``
|
||||
(for Twisted) or ``Future`` (for asyncio) objects, **txaio** provides
|
||||
helper-functions to do that for you, as well as associated things like
|
||||
adding callbacks or errbacks.
|
||||
|
||||
This obviously changes the style of your code, but then you can choose
|
||||
at runtime (or import time) which underlying event-loop to use. This
|
||||
means you can write **one** code-base that can run on Twisted *or*
|
||||
asyncio (without a Twisted dependency) as you or your users see fit.
|
||||
|
||||
Code like the following can then run on *either* system:
|
||||
|
||||
.. sourcecode:: python
|
||||
|
||||
f0 = txaio.create_future()
|
||||
f1 = txaio.as_future(some_func, 1, 2, key='word')
|
||||
txaio.add_callbacks(f0, callback, errback)
|
||||
txaio.add_callbacks(f1, callback, errback)
|
||||
# ...
|
||||
txaio.resolve(f0, "value")
|
||||
txaio.reject(f1, RuntimeError("it failed"))
|
||||
|
||||
|
||||
.. |Version| image:: https://img.shields.io/pypi/v/txaio.svg
|
||||
:target: https://pypi.python.org/pypi/txaio
|
||||
|
||||
.. |Downloads| image:: https://img.shields.io/pypi/dm/txaio.svg
|
||||
:target: https://pypi.python.org/pypi/txaio
|
||||
|
||||
.. |GitHub Stars| image:: https://img.shields.io/github/stars/crossbario/txaio.svg?style=social&label=Star
|
||||
:target: https://github.com/crossbario/txaio
|
||||
|
||||
.. |Master Branch| image:: https://img.shields.io/badge/branch-master-orange.svg
|
||||
:target: https://travis-ci.org/crossbario/txaio.svg?branch=master
|
||||
|
||||
.. |Build Status| image:: https://travis-ci.org/crossbario/txaio.svg?branch=master
|
||||
:target: https://travis-ci.org/crossbario/txaio
|
||||
|
||||
.. |Coverage| image:: https://img.shields.io/codecov/c/github/crossbario/txaio/master.svg
|
||||
:target: https://codecov.io/github/crossbario/txaio
|
||||
|
||||
.. |Docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
|
||||
:target: http://txaio.readthedocs.org/en/latest/
|
||||
1
docs/index.rst
Symbolic link
1
docs/index.rst
Symbolic link
@ -0,0 +1 @@
|
||||
../README.rst
|
||||
Loading…
Reference in New Issue
Block a user