litexpy 0.0.6

Python runner for an interactive litex terminal session.

litexpy

Python runner for an interactive litex terminal session.

Links

• PyPI: https://pypi.org/project/litexpy/
• GitHub: https://github.com/litexlang/litexpy

Prerequisites

litexpy starts the local litex command in an interactive terminal session. It does not bundle the Litex executable, so install Litex first if litex is not already available in your terminal.

If you already have Litex

If litex -version works in your terminal, install only the Python package:

pip install litexpy

If you have not installed Litex

Install Litex first locally on your machine, then install litexpy.

Setup guide: https://litexlang.com/doc/Setup

Usage

Create a runner:

import litexpy

runner = litexpy.Runner()

Run Litex code and read the JSON results:

results = runner.run("1 = 1")

print(results[0]["result"])
print(results[0]["stmt"])

Run multiple input lines in the same interactive Litex session:

results = runner.run("1 = 1\n0 = 0")

Clear the Litex session:

clear_result = runner.clear()

Close the Litex process:

runner.quit()

Use a custom Litex command path or argument list:

runner = litexpy.Runner("/path/to/litex")
runner = litexpy.Runner(["/path/to/litex"])

Use the factory helper:

runner = litexpy.runner()

Read the installed package version:

print(litexpy.__version__)

litexpy exposes Runner, runner(), and __version__. Runner() starts the litex command in an interactive terminal process. run(script) sends script to that process and returns the JSON results as a list of Python dict objects. clear() is equivalent to run("clear"). quit() closes the running litex process.