Dependencies

Xonsh currently has the following external dependencies,

Run Time:

  1. Python v3.4+
  2. PLY (optional, included with xonsh)

Pip supports “extra” dependendcies in the form of xonsh[ptk,linux], where the list in the brackets identify the optional featues

Xonsh currently has the following extras

  1. ptk: prompt-toolkit, pygments: advanced readline library, syntax-highlighting, line-editing
  2. proctitle: setproctitle: change the title of terminal to reflect the current subprocess
  3. linux: distro: linux specific platform information
  4. mac: gnureadline: GNU’s featureful version of readline
  5. win: win_unicode_console: enables the use of Unicode in windows consoles

In addition, xonsh integrates with Jupyter, an in-browser REPL, enabling the use of xonsh in jupyter notebooks

Development Dependencies

If you want to develop xonsh, it is extremely recommended to install the dependencies listed in requirements-docs.txt (to generate documentation) and requirements-tests.txt (to run the test suite).