goodboy
/
tractor
1
0
Fork 1
Code Issues 1 Pull Requests 4 Packages Projects Releases Wiki Activity
tractor/README.rst

83 lines
3.3 KiB
ReStructuredText
Raw Normal View History

Initial readme documenting most features There is a slew of tests to match to verify everything documented thus far. Hopefully it's a decent little start :)
2018-07-06 06:34:11 +00:00
tractor
=======
Be more stingy about "actor model"
2019-03-07 02:30:00 +00:00
An async-native "`actor model`_" built on trio_ and multiprocessing_.
Draft v2 after new `run_in_actor()` API Revamp the docs after some feedback from @vodik. See #24 #25 for additional details.
2018-08-03 04:55:50 +00:00
Initial readme documenting most features There is a slew of tests to match to verify everything documented thus far. Hopefully it's a decent little start :)
2018-07-06 06:34:11 +00:00
Add CI badge
2018-07-13 15:34:43 +00:00
|travis|
Flip travis badge to new username
2019-03-17 19:18:44 +00:00
.. |travis| image:: https://img.shields.io/travis/goodboy/tractor/master.svg
:target: https://travis-ci.org/goodboy/tractor
Add CI badge
2018-07-13 15:34:43 +00:00
Draft v2 after new `run_in_actor()` API Revamp the docs after some feedback from @vodik. See #24 #25 for additional details.
2018-08-03 04:55:50 +00:00
Readme description bump after talks with multiple would-be users
2019-11-22 21:43:49 +00:00
``tractor`` is an attempt to bring trionic_ `structured concurrency`_ to
distributed multi-core Python.
``tractor`` lets you spawn ``trio`` *"actors"*: processes which each run
a ``trio`` scheduled task tree (also known as an `async sandwich`_).
*Actors* communicate by exchanging asynchronous messages_ and avoid
sharing any state. This model allows for highly distributed software
architecture which works just as well on multiple cores as it does over
many hosts.
Be more stingy about "actor model"
2019-03-07 02:30:00 +00:00
The first step to grok ``tractor`` is to get the basics of ``trio`` down.
A great place to start is the `trio docs`_ and this `blog post`_.
Initial readme documenting most features There is a slew of tests to match to verify everything documented thus far. Hopefully it's a decent little start :)
2018-07-06 06:34:11 +00:00
Remove duplicate docs from readme
2020-02-10 04:52:23 +00:00
.. _actor model: https://en.wikipedia.org/wiki/Actor_model
.. _trio: https://github.com/python-trio/trio
.. _multiprocessing: https://en.wikipedia.org/wiki/Multiprocessing
.. _trionic: https://trio.readthedocs.io/en/latest/design.html#high-level-design-principles
.. _async sandwich: https://trio.readthedocs.io/en/latest/tutorial.html#async-sandwich
.. _always propagate: https://trio.readthedocs.io/en/latest/design.html#exceptions-always-propagate
.. _causality: https://vorpus.org/blog/some-thoughts-on-asynchronous-api-design-in-a-post-asyncawait-world/#c-c-c-c-causality-breaker
.. _shared nothing architecture: https://en.wikipedia.org/wiki/Shared-nothing_architecture
.. _cancellation: https://trio.readthedocs.io/en/latest/reference-core.html#cancellation-and-timeouts
.. _channels: https://en.wikipedia.org/wiki/Channel_(programming)
.. _chaos engineering: http://principlesofchaos.org/
Draft v2 after new `run_in_actor()` API Revamp the docs after some feedback from @vodik. See #24 #25 for additional details.
2018-08-03 04:55:50 +00:00
.. _messages: https://en.wikipedia.org/wiki/Message_passing
.. _trio docs: https://trio.readthedocs.io/en/latest/
.. _blog post: https://vorpus.org/blog/notes-on-structured-concurrency-or-go-statement-considered-harmful/
Drop sillyness in intro
2018-09-21 00:30:57 +00:00
.. _structured concurrency: https://vorpus.org/blog/notes-on-structured-concurrency-or-go-statement-considered-harmful/
Add context examples
2019-01-21 16:38:09 +00:00
Draft v2 after new `run_in_actor()` API Revamp the docs after some feedback from @vodik. See #24 #25 for additional details.
2018-08-03 04:55:50 +00:00
Philosophy
----------
Be more stingy about "actor model"
2019-03-07 02:30:00 +00:00
``tractor`` aims to be the Python multi-processing framework *you always wanted*.
Its tenets non-comprehensively include:
Initial readme documenting most features There is a slew of tests to match to verify everything documented thus far. Hopefully it's a decent little start :)
2018-07-06 06:34:11 +00:00
Be more stingy about "actor model"
2019-03-07 02:30:00 +00:00
- strict adherence to the `concept-in-progress`_ of *structured concurrency*
Initial readme documenting most features There is a slew of tests to match to verify everything documented thus far. Hopefully it's a decent little start :)
2018-07-06 06:34:11 +00:00
- no spawning of processes *willy-nilly*; causality_ is paramount!
Readme description bump after talks with multiple would-be users
2019-11-22 21:43:49 +00:00
- (remote) errors `always propagate`_ back to the parent supervisor
Initial readme documenting most features There is a slew of tests to match to verify everything documented thus far. Hopefully it's a decent little start :)
2018-07-06 06:34:11 +00:00
- verbatim support for ``trio``'s cancellation_ system
Be more stingy about "actor model"
2019-03-07 02:30:00 +00:00
- `shared nothing architecture`_
User name and email bump
2019-04-28 14:41:24 +00:00
- no use of *proxy* objects or shared references between processes
Initial readme documenting most features There is a slew of tests to match to verify everything documented thus far. Hopefully it's a decent little start :)
2018-07-06 06:34:11 +00:00
- an immersive debugging experience
Draft v2 after new `run_in_actor()` API Revamp the docs after some feedback from @vodik. See #24 #25 for additional details.
2018-08-03 04:55:50 +00:00
- anti-fragility through `chaos engineering`_
Initial readme documenting most features There is a slew of tests to match to verify everything documented thus far. Hopefully it's a decent little start :)
2018-07-06 06:34:11 +00:00
Be more stingy about "actor model"
2019-03-07 02:30:00 +00:00
Initial readme documenting most features There is a slew of tests to match to verify everything documented thus far. Hopefully it's a decent little start :)
2018-07-06 06:34:11 +00:00
.. warning:: ``tractor`` is in alpha-alpha and is expected to change rapidly!
Draft v2 after new `run_in_actor()` API Revamp the docs after some feedback from @vodik. See #24 #25 for additional details.
2018-08-03 04:55:50 +00:00
Expect nothing to be set in stone. Your ideas about where it should go
are greatly appreciated!
Initial readme documenting most features There is a slew of tests to match to verify everything documented thus far. Hopefully it's a decent little start :)
2018-07-06 06:34:11 +00:00
Be more stingy about "actor model"
2019-03-07 02:30:00 +00:00
.. _concept-in-progress: https://trio.discourse.group/t/structured-concurrency-kickoff/55
Add simpler intro As per a suggestion from @njsmith I've added a little less verbose intro which mentions *actors* up front. More, - add install cmd - reorg spawning and portal sections a wee bit
2018-07-12 19:18:02 +00:00
Add TOC and examples subsections
2019-01-21 16:56:33 +00:00
Add simpler intro As per a suggestion from @njsmith I've added a little less verbose intro which mentions *actors* up front. More, - add install cmd - reorg spawning and portal sections a wee bit
2018-07-12 19:18:02 +00:00
Install
-------
No PyPi release yet!
::
User name and email bump
2019-04-28 14:41:24 +00:00
pip install git+git://github.com/goodboy/tractor.git
Initial readme documenting most features There is a slew of tests to match to verify everything documented thus far. Hopefully it's a decent little start :)
2018-07-06 06:34:11 +00:00
Document context api
2019-01-17 04:19:29 +00:00
Feel like saying hi?
--------------------
This project is very much coupled to the ongoing development of
``trio`` (i.e. ``tractor`` gets all its ideas from that brilliant
community). If you want to help, have suggestions or just want to
say hi, please feel free to ping me on the `trio gitter channel`_!
Initial readme documenting most features There is a slew of tests to match to verify everything documented thus far. Hopefully it's a decent little start :)
2018-07-06 06:34:11 +00:00
.. _trio gitter channel: https://gitter.im/python-trio/general