Skip to content

Add programatic usage example, #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adiroiban wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add programatic usage example, #93

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,15 +148,15 @@ See the `JMESPath specification`_ for more information.
Programmatic usage
------------------

For now, just an example in non-streaming mode.

.. code-block:: python

import json, sys
from eliottree import tasks_from_iterable, render_tasks
# Or `codecs.getwriter('utf-8')(sys.stdout).write` on Python 2.
render_tasks(sys.stdout.write, tasks, colorize=True)
import sys
from eliottree._cli import parse_messages, render_tasks
_, tasks = parse_messages([open('/path/to/your/log', 'r')])
render_tasks(sys.stdout.write, tasks)

See :code:`help(render_tasks)` and :code:`help(tasks_from_iterable)` from a
Python REPL for more information.

Configuration
-------------
Expand Down