tractor/docs/project/index.rst

Project
=======
Everything meta: where the project's been (the
:doc:`changelog`), where it's going (the roadmap below),
how to hack on it (:doc:`dev-tips` and
:doc:`/guide/testing`) and where to find the humans.

.. toctree::
   :maxdepth: 1

   changelog
   dev-tips

What the future holds
---------------------
Help us push toward the future of distributed Python!
Planned (or dreamed of) work non-comprehensively
includes,

- Erlang-style supervisors via composed context
  managers (see `#22`_),
- typed capability-based (dialog) protocols, ie.
  evolving our `msg-spec`_ system into per-dialog
  contracts (see `#196`_ with draft work in `#311`_),
- a higher level "service manager" API for daemon
  lifetime mgmt over actor trees (in the works on an
  experimental branch as ``tractor.hilevel``),
- richer `discovery`_ via gossip and/or
  `rendezvous protocol`_ approaches (today's registrar
  is intentionally naive),
- more IPC transports: the current ``tcp`` | ``uds``
  pair wants friends (QUIC, shm-ring-buffers, RUDP,
  wireguard tunnels),
- an extensive `chaos engineering`_ test suite,
- a respawn-from-REPL system for crashed (sub-)actors.

Feel like saying hi?
--------------------
This project is very much coupled to the ongoing
development of ``trio`` (i.e. ``tractor`` gets most of
its ideas from that brilliant community). If you want
to help, have suggestions or just want to say hi,
please feel free to reach us in our `matrix channel`_.
If matrix seems too hip, we're also mostly all in the
`trio gitter channel`_!

Contributions of all kinds welcome: docs, examples,
bug reports, new transports, supervisor strategies,
philosophical debates about what an "actor model"
really is B)

.. _#22: https://github.com/goodboy/tractor/issues/22
.. _#196: https://github.com/goodboy/tractor/issues/196
.. _#311: https://github.com/goodboy/tractor/pull/311
.. _msg-spec: https://jcristharif.com/msgspec/
.. _discovery: https://zguide.zeromq.org/docs/chapter8/#Discovery
.. _rendezvous protocol: https://en.wikipedia.org/wiki/Rendezvous_protocol
.. _chaos engineering: https://principlesofchaos.org/
.. _matrix channel: https://matrix.to/#/!tractor:matrix.org
.. _trio gitter channel: https://gitter.im/python-trio/general
Write the big boi docs content tree Replace the ancient `docs/index.rst` (still teaching `tractor.run()`, `@stream` + arbiters..) with a full ~32 page tree teaching ONLY the current api (`.wait_for_result()`, registrar naming, `@context` + `open_context()` as the core model), - landing: hero example, feature cards + canon links, - `start/`: install + a 4-example quickstart on-ramp, - `explain/`: an "SC across processes" essay distilling the essence per #157's orig ask + a runtime architecture tour, - `guide/`: 12 task-focused pages incl the flagship multi-process debugging walkthrough, `Context` + `MsgStream` deep-dives, cancellation semantics (self-vs-cross cancel rules), discovery, infected `asyncio`, typed msging + the #126 testing-tips page, - `api/`: 10 curated autodoc pages (all targets import-verified vs the reorg'd subpkg tree), - `project/`: changelog include, ported dev-tips (drops old `docs/dev_tips.rst`) + roadmap. Every code block is a `literalinclude` from `examples/` - zero duplication, all CI-run - w/ `d2` figs floated into the RHS margin per the 3-col design. Build is green; the 24 remaining warnings all source from lib docstring rst-isms or legacy `NEWS.rst` content. Substantially resolves #157 (refine round pending); chips at #175 + #126. Prompt-IO: ai/prompt-io/claude/20260611T175152Z_8526985c_prompt_io.md (this patch was generated in some part by [`claude-code`][claude-code-gh]) [claude-code-gh]: https://github.com/anthropics/claude-code 2026-06-11 19:17:14 +00:00			`Project`
			`=======`
			`Everything meta: where the project's been (the`
			:doc:`changelog`), where it's going (the roadmap below),
			how to hack on it (:doc:`dev-tips` and
			:doc:`/guide/testing`) and where to find the humans.

			`.. toctree::`
			`:maxdepth: 1`

			`changelog`
			`dev-tips`

			`What the future holds`
			`---------------------`
			`Help us push toward the future of distributed Python!`
			`Planned (or dreamed of) work non-comprehensively`
			`includes,`

			`- Erlang-style supervisors via composed context`
			managers (see `#22`_),
			`- typed capability-based (dialog) protocols, ie.`
			evolving our `msg-spec`_ system into per-dialog
			contracts (see `#196`_ with draft work in `#311`_),
			`- a higher level "service manager" API for daemon`
			`lifetime mgmt over actor trees (in the works on an`
			experimental branch as ``tractor.hilevel``),
			- richer `discovery`_ via gossip and/or
			`rendezvous protocol`_ approaches (today's registrar
			`is intentionally naive),`
			- more IPC transports: the current ``tcp`` \| ``uds``
			`pair wants friends (QUIC, shm-ring-buffers, RUDP,`
			`wireguard tunnels),`
			- an extensive `chaos engineering`_ test suite,
			`- a respawn-from-REPL system for crashed (sub-)actors.`

			`Feel like saying hi?`
			`--------------------`
			`This project is very much coupled to the ongoing`
			development of ``trio`` (i.e. ``tractor`` gets most of
			`its ideas from that brilliant community). If you want`
			`to help, have suggestions or just want to say hi,`
			please feel free to reach us in our `matrix channel`_.
			`If matrix seems too hip, we're also mostly all in the`
			`trio gitter channel`_!

			`Contributions of all kinds welcome: docs, examples,`
			`bug reports, new transports, supervisor strategies,`
			`philosophical debates about what an "actor model"`
			`really is B)`

			`.. _#22: https://github.com/goodboy/tractor/issues/22`
			`.. _#196: https://github.com/goodboy/tractor/issues/196`
			`.. _#311: https://github.com/goodboy/tractor/pull/311`
			`.. _msg-spec: https://jcristharif.com/msgspec/`
			`.. _discovery: https://zguide.zeromq.org/docs/chapter8/#Discovery`
			`.. _rendezvous protocol: https://en.wikipedia.org/wiki/Rendezvous_protocol`
			`.. _chaos engineering: https://principlesofchaos.org/`
			`.. _matrix channel: https://matrix.to/#/!tractor:matrix.org`
			`.. _trio gitter channel: https://gitter.im/python-trio/general`