xonsh/docs/dependencies.rst

Dependencies
------------
Xonsh currently has the following external dependencies,

*Run Time:*

    #. Python v3.4+

Pip supports "extra" dependencies in the form of ``xonsh[ptk,linux]``, where
the list in the brackets identify the optional features

Xonsh currently has the following extras

    #. ``ptk``: prompt-toolkit:
       *advanced readline library, line-editing*
    #. ``pygments>=2.2``: *syntax-highlighting*
    #. ``proctitle``: setproctitle: *change the title of terminal to reflect the current subprocess*
    #. ``linux``: distro: *linux specific platform information*
    #. ``mac``: gnureadline: *GNU's featureful version of readline*
    #. ``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 <https://github.com/xonsh/xonsh/blob/master/requirements/docs.txt>`_ (to generate documentation) and `requirements/tests.txt <https://github.com/xonsh/xonsh/blob/master/requirements/tests.txt>`_ (to run the test suite).
update docs with OS specific install instructions * Added individual pages for Windows, Linux and OSX with install instructions. * Dependencies were broken out into separate rst files and `include`d to avoid a lot of repetition * Added instructions for adding `xonsh` to `/etc/shells` to standalone rst file and `include`d them on OSX and Linux install pages 2016-04-06 18:31:19 -04:00			`Dependencies`
Clean up install docs 2019-02-05 19:03:06 -05:00			`------------`
update docs with OS specific install instructions * Added individual pages for Windows, Linux and OSX with install instructions. * Dependencies were broken out into separate rst files and `include`d to avoid a lot of repetition * Added instructions for adding `xonsh` to `/etc/shells` to standalone rst file and `include`d them on OSX and Linux install pages 2016-04-06 18:31:19 -04:00			`Xonsh currently has the following external dependencies,`

			`Run Time:`

			`#. Python v3.4+`
Attempt to document extras 2016-09-29 22:57:18 -04:00
update dependencies in setup.py and docs 2017-01-27 11:18:16 -05:00			Pip supports "extra" dependencies in the form of ``xonsh[ptk,linux]``, where
			`the list in the brackets identify the optional features`
Attempt to document extras 2016-09-29 22:57:18 -04:00
			`Xonsh currently has the following extras`

update dependencies in setup.py and docs 2017-01-27 11:18:16 -05:00			#. ``ptk``: prompt-toolkit:
			`advanced readline library, line-editing`
Remove support of pygments <2.2 2018-07-21 22:55:25 +02:00			#. ``pygments>=2.2``: syntax-highlighting
Attempt to document extras 2016-09-29 22:57:18 -04:00			#. ``proctitle``: setproctitle: change the title of terminal to reflect the current subprocess
			#. ``linux``: distro: linux specific platform information
			#. ``mac``: gnureadline: GNU's featureful version of readline
			#. ``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`
update docs with OS specific install instructions * Added individual pages for Windows, Linux and OSX with install instructions. * Dependencies were broken out into separate rst files and `include`d to avoid a lot of repetition * Added instructions for adding `xonsh` to `/etc/shells` to standalone rst file and `include`d them on OSX and Linux install pages 2016-04-06 18:31:19 -04:00
Attempt to document extras 2016-09-29 22:57:18 -04:00			`Development Dependencies`
Clean up install docs 2019-02-05 19:03:06 -05:00			`------------------------`
update docs with OS specific install instructions * Added individual pages for Windows, Linux and OSX with install instructions. * Dependencies were broken out into separate rst files and `include`d to avoid a lot of repetition * Added instructions for adding `xonsh` to `/etc/shells` to standalone rst file and `include`d them on OSX and Linux install pages 2016-04-06 18:31:19 -04:00
black not available on 3.5 2019-07-19 17:30:34 -04:00			If you want to develop xonsh, it is extremely recommended to install the dependencies listed in `requirements/docs.txt <https://github.com/xonsh/xonsh/blob/master/requirements/docs.txt>`_ (to generate documentation) and `requirements/tests.txt <https://github.com/xonsh/xonsh/blob/master/requirements/tests.txt>`_ (to run the test suite).