2015-03-07 23:22:13 -06:00
|
|
|
=============================
|
|
|
|
|
Xonsh 0.1 Release Notes
|
|
|
|
|
=============================
|
|
|
|
|
xonsh is a Python-ish, BASHwards-compatible shell language and command prompt.
|
|
|
|
|
The language is a superset of Python 3.4 with additional shell primitives
|
|
|
|
|
that you are used to from BASH and IPython. xonsh is
|
|
|
|
|
meant for the daily use of experts and novices alike.
|
|
|
|
|
|
2015-03-09 00:14:38 -05:00
|
|
|
Features include:
|
|
|
|
|
|
|
|
|
|
* Naturally typed environment variables
|
|
|
|
|
* Inherits the environment from BASH
|
|
|
|
|
* Uses BASH completion for subprocess commands
|
|
|
|
|
* Regular expression filename globbing
|
|
|
|
|
* Its own PLY-based lexer and parser
|
|
|
|
|
* xonsh code parses into a Python AST
|
|
|
|
|
* You can do all the normal Python things, like arithmetic and importing
|
|
|
|
|
* Captured and uncaptured subprocesses
|
|
|
|
|
* Pipes, redirection, and non-blocking subprocess syntax support
|
|
|
|
|
* Help and superhelp with ? and ??
|
|
|
|
|
* Command aliasing
|
|
|
|
|
* Multiline input, unlike ed
|
|
|
|
|
* History matching like in IPython
|
|
|
|
|
* Color prompts
|
|
|
|
|
* Low system overhead
|
|
|
|
|
|
|
|
|
|
Feedback, bug reports, and pull requests are always welcome!
|
|
|
|
|
|
|
|
|
|
Installation
|
|
|
|
|
============
|
|
|
|
|
You can install xonsh using conda, pip, or from source.
|
|
|
|
|
|
|
|
|
|
conda::
|
|
|
|
|
|
|
|
|
|
$ conda install -c https://conda.binstar.org/scopatz xonsh
|
|
|
|
|
|
|
|
|
|
pip::
|
|
|
|
|
|
|
|
|
|
$ pip install xonsh
|
|
|
|
|
|
|
|
|
|
source: Download the source from github (https://github.com/scopatz/xonsh)
|
|
|
|
|
or the zip file (https://github.com/scopatz/xonsh/archive/master.zip), then
|
|
|
|
|
run the following from the source directory::
|
|
|
|
|
|
|
|
|
|
$ python setup.py install
|
|
|
|
|
|
|
|
|
|
If you run into any problems, please let us know!
|
|
|
|
|
|
|
|
|
|
Dependencies
|
|
|
|
|
============
|
|
|
|
|
Polyphemus currently has the following external dependencies,
|
|
|
|
|
|
|
|
|
|
*Run Time:*
|
|
|
|
|
|
|
|
|
|
1. Python v3.4+
|
|
|
|
|
2. PLY
|
|
|
|
|
|
|
|
|
|
Contributing
|
|
|
|
|
============
|
|
|
|
|
We highly encourage contributions to xonsh! If you would like to contribute,
|
|
|
|
|
it is as easy as forking the repository on GitHub, making your changes, and
|
|
|
|
|
issuing a pull request. If you have any questions about this process don't
|
|
|
|
|
hesitate to ask the mailing list (xonsh@googlegroups.com).
|
|
|
|
|
|
|
|
|
|
Contact Us
|
|
|
|
|
==========
|
|
|
|
|
If you have questions or comments, please send them to the mailing list
|
|
|
|
|
xonsh@googlegroups.com, contact the author directly, or open an issue on
|
|
|
|
|
GitHub.
|
|
|
|
|
|
|
|
|
|
Join the mailing list here: https://groups.google.com/forum/#!forum/xonsh
|
|
|
|
|
|
|
|
|
|
Helpful Links
|
|
|
|
|
=============
|
|
|
|
|
* Documentation - http://xonsh.org
|
|
|
|
|
* Mailing list - https://groups.google.com/forum/#!forum/xonsh
|
|
|
|
|
* GitHub Repository - https://github.com/scopatz/xonsh
|
|
|
|
|
|
2015-03-07 23:22:13 -06:00
|
|
|
Authors
|
|
|
|
|
=======
|
|
|
|
|
This release contains code written by the following people (in alphabetical
|
|
|
|
|
order):
|
|
|
|
|
|
|
|
|
|
* Anthony Scopatz
|
