| Name | xonsh JSON |
| Version |
0.19.1
JSON |
| download |
| home_page | None |
| Summary | Python-powered shell. Full-featured and cross-platform. |
| upload_time | 2025-01-13 16:55:42 |
| maintainer | Xonsh Community |
| docs_url | None |
| author | Anthony Scopatz |
| requires_python | >=3.9 |
| license | BSD 2-Clause License |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
xonsh
=====
.. class:: center
**xonsh** is a Python-powered shell. Full-featured and cross-platform. The language is a superset of Python 3.6+ with additional shell primitives. Xonsh word was made from *conch* (🐚, *@*) and indicates belonging to the command shells world.
.. list-table::
:widths: 1 1
* - **Xonsh is the Shell**
- **Xonsh is Python**
* - .. code-block:: shell
cd $HOME
id $(whoami)
cat /etc/passwd | grep root > ~/root.txt
$PROMPT = '@ '
- .. code-block:: python
2 + 2
var = "hello".upper()
import json; json.loads('{"a":1}')
[i for i in range(0,10)]
* - **Xonsh is the Shell in Python**
- **Xonsh is Python in the Shell**
* - .. code-block:: python
len($(curl -L https://xon.sh))
$PATH.append('/tmp')
p'/etc/passwd'.read_text().find('root')
xontrib load dalias
id = $(@json docker ps --format json)['ID']
- .. code-block:: python
name = 'foo' + 'bar'.upper()
echo @(name) > /tmp/@(name)
ls @(input('file: '))
touch @([f"file{i}" for i in range(0,10)])
aliases['e'] = 'echo @(2+2)'
aliases['a'] = lambda args: print(args)
If you like xonsh, :star: the repo, `write a tweet`_ and stay tuned by watching releases.
.. class:: center
.. image:: https://img.shields.io/badge/Zulip%20Community-xonsh-green
:target: https://xonsh.zulipchat.com/join/hbvue5rimpdkwkdjuiqfs7tv/
:alt: Join to xonsh.zulipchat.com
.. image:: https://github.com/xonsh/xonsh/actions/workflows/test.yml/badge.svg
:target: https://github.com/xonsh/xonsh/actions/workflows/test.yml
:alt: GitHub Actions
.. image:: https://codecov.io/gh/xonsh/xonsh/branch/master/graphs/badge.svg?branch=main
:target: https://codecov.io/github/xonsh/xonsh?branch=main
:alt: codecov.io
.. image:: https://repology.org/badge/tiny-repos/xonsh.svg
:target: https://repology.org/project/xonsh/versions
:alt: repology.org
First steps
***********
Install xonsh from pip:
.. code-block:: xonshcon
python -m pip install 'xonsh[full]'
And visit https://xon.sh for more information:
- `Installation <https://xon.sh/contents.html#installation>`_ - using packages, docker or AppImage.
- `Tutorial <https://xon.sh/tutorial.html>`_ - step by step introduction in xonsh.
Extensions
**********
Xonsh has an extension/plugin system. We call these additions ``xontribs``.
- `Xontribs on Github <https://github.com/topics/xontrib>`_
- `Awesome xontribs <https://github.com/xonsh/awesome-xontribs>`_
- `Core xontribs <https://xon.sh/api/_autosummary/xontribs/xontrib.html>`_
- `Create a xontrib step by step from template <https://github.com/xonsh/xontrib-template>`_
Projects that use xonsh or compatible
*************************************
- `conda <https://conda.io/projects/conda/en/latest/>`_ and `mamba <https://mamba.readthedocs.io/en/latest/>`_: Modern package managers.
- `Starship <https://starship.rs/>`_: Cross-shell prompt.
- `zoxide <https://github.com/ajeetdsouza/zoxide>`_: A smarter cd command.
- `gitsome <https://github.com/donnemartin/gitsome>`_: Supercharged Git/shell autocompleter with GitHub integration.
- `xxh <https://github.com/xxh/xxh>`_: Using xonsh wherever you go through the SSH.
- `any-nix-shell <https://github.com/haslersn/any-nix-shell>`_: xonsh support for the ``nix run`` and ``nix-shell`` environments of the Nix package manager.
- `lix <https://github.com/lix-project/lix>`_: A modern, delicious implementation of the Nix package manager.
- `x-cmd <https://www.x-cmd.com/>`_: x-cmd is a vast and interesting collection of tools guided by the Unix philosophy.
- `rever <https://regro.github.io/rever-docs/>`_: Cross-platform software release tool.
- `Regro autotick bot <https://github.com/regro/cf-scripts>`_: Regro Conda-Forge autoticker.
Jupyter-based interactive notebooks via `xontrib-jupyter <https://github.com/xonsh/xontrib-jupyter>`_:
- `Jupyter and JupyterLab <https://jupyter.org/>`_: Interactive notebook platform.
- `euporie <https://github.com/joouha/euporie>`_: Terminal based interactive computing environment.
- `Jupytext <https://jupytext.readthedocs.io/>`_: Clear and meaningful diffs when doing Jupyter notebooks version control.
The xonsh shell community
*************************
The xonsh shell is developed by a community of volunteers. There are a few ways to help out:
- Solve a `popular issue <https://github.com/xonsh/xonsh/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc>`_ or `high priority issue <https://github.com/xonsh/xonsh/issues?q=is%3Aopen+is%3Aissue+label%3Apriority-high+sort%3Areactions-%2B1-desc>`_ or a `good first issue <https://github.com/xonsh/xonsh/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+sort%3Areactions-%2B1-desc>`_. You can start with the `Developer guide <https://xon.sh/devguide.html>`_.
- Take an `idea <https://github.com/xonsh/xontrib-template/issues?q=is%3Aopen+is%3Aissue+label%3Aidea+sort%3Areactions-%2B1-desc>`_ and `create a new xontrib <https://github.com/xonsh/xontrib-template#why-use-this-template>`_.
- Contribute to `xonsh API <https://github.com/xonsh/xonsh/tree/main/xonsh/api>`_.
- Become xonsh core developer by deep diving into xonsh internals. E.g. we feel a lack of Windows support.
- `Become a sponsor to xonsh <https://github.com/sponsors/xonsh>`_.
- `Write a tweet`_, post or an article to spread the good word about xonsh in the world.
- Give a star to xonsh repository and to `xontribs <https://github.com/topics/xontrib>`_ you like.
We welcome new contributors!
.. _write a tweet: https://twitter.com/intent/tweet?text=xonsh%20is%20a%20Python-powered,%20cross-platform,%20Unix-gazing%20shell%20language%20and%20command%20prompt.&url=https://github.com/xonsh/xonsh
Credits
*******
- Thanks to `Zulip <https://zulip.com/>`_ for supporting the xonsh community!
Raw data
{
"_id": null,
"home_page": null,
"name": "xonsh",
"maintainer": "Xonsh Community",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "xonsh@gil.forsyth.dev",
"keywords": null,
"author": "Anthony Scopatz",
"author_email": "scopatz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/98/6e/b54a0b2685535995ee50f655103c463f9d339455c9b08c4bce3e03e7bb17/xonsh-0.19.1.tar.gz",
"platform": "Cross Platform",
"description": "xonsh\n=====\n\n.. class:: center\n\n **xonsh** is a Python-powered shell. Full-featured and cross-platform. The language is a superset of Python 3.6+ with additional shell primitives. Xonsh word was made from *conch* (\ud83d\udc1a, *@*) and indicates belonging to the command shells world.\n\n\n.. list-table::\n :widths: 1 1\n\n * - **Xonsh is the Shell**\n - **Xonsh is Python**\n\n * - .. code-block:: shell\n\n cd $HOME\n\n id $(whoami)\n\n cat /etc/passwd | grep root > ~/root.txt\n\n $PROMPT = '@ '\n\n\n - .. code-block:: python\n\n 2 + 2\n\n var = \"hello\".upper()\n\n import json; json.loads('{\"a\":1}')\n\n [i for i in range(0,10)]\n\n * - **Xonsh is the Shell in Python**\n - **Xonsh is Python in the Shell**\n\n * - .. code-block:: python\n\n len($(curl -L https://xon.sh))\n\n $PATH.append('/tmp')\n\n p'/etc/passwd'.read_text().find('root')\n\n xontrib load dalias\n id = $(@json docker ps --format json)['ID']\n\n - .. code-block:: python\n\n name = 'foo' + 'bar'.upper()\n echo @(name) > /tmp/@(name)\n\n ls @(input('file: '))\n touch @([f\"file{i}\" for i in range(0,10)])\n\n aliases['e'] = 'echo @(2+2)'\n aliases['a'] = lambda args: print(args)\n\n\nIf you like xonsh, :star: the repo, `write a tweet`_ and stay tuned by watching releases.\n\n.. class:: center\n\n .. image:: https://img.shields.io/badge/Zulip%20Community-xonsh-green\n :target: https://xonsh.zulipchat.com/join/hbvue5rimpdkwkdjuiqfs7tv/\n :alt: Join to xonsh.zulipchat.com\n\n .. image:: https://github.com/xonsh/xonsh/actions/workflows/test.yml/badge.svg\n :target: https://github.com/xonsh/xonsh/actions/workflows/test.yml\n :alt: GitHub Actions\n\n .. image:: https://codecov.io/gh/xonsh/xonsh/branch/master/graphs/badge.svg?branch=main\n :target: https://codecov.io/github/xonsh/xonsh?branch=main\n :alt: codecov.io\n\n .. image:: https://repology.org/badge/tiny-repos/xonsh.svg\n :target: https://repology.org/project/xonsh/versions\n :alt: repology.org\n\n\nFirst steps\n***********\n\nInstall xonsh from pip:\n\n.. code-block:: xonshcon\n\n python -m pip install 'xonsh[full]'\n\nAnd visit https://xon.sh for more information:\n\n- `Installation <https://xon.sh/contents.html#installation>`_ - using packages, docker or AppImage.\n- `Tutorial <https://xon.sh/tutorial.html>`_ - step by step introduction in xonsh.\n\nExtensions\n**********\n\nXonsh has an extension/plugin system. We call these additions ``xontribs``.\n\n- `Xontribs on Github <https://github.com/topics/xontrib>`_\n- `Awesome xontribs <https://github.com/xonsh/awesome-xontribs>`_\n- `Core xontribs <https://xon.sh/api/_autosummary/xontribs/xontrib.html>`_\n- `Create a xontrib step by step from template <https://github.com/xonsh/xontrib-template>`_\n\nProjects that use xonsh or compatible\n*************************************\n\n- `conda <https://conda.io/projects/conda/en/latest/>`_ and `mamba <https://mamba.readthedocs.io/en/latest/>`_: Modern package managers.\n- `Starship <https://starship.rs/>`_: Cross-shell prompt.\n- `zoxide <https://github.com/ajeetdsouza/zoxide>`_: A smarter cd command.\n- `gitsome <https://github.com/donnemartin/gitsome>`_: Supercharged Git/shell autocompleter with GitHub integration.\n- `xxh <https://github.com/xxh/xxh>`_: Using xonsh wherever you go through the SSH.\n- `any-nix-shell <https://github.com/haslersn/any-nix-shell>`_: xonsh support for the ``nix run`` and ``nix-shell`` environments of the Nix package manager.\n- `lix <https://github.com/lix-project/lix>`_: A modern, delicious implementation of the Nix package manager.\n- `x-cmd <https://www.x-cmd.com/>`_: x-cmd is a vast and interesting collection of tools guided by the Unix philosophy.\n- `rever <https://regro.github.io/rever-docs/>`_: Cross-platform software release tool.\n- `Regro autotick bot <https://github.com/regro/cf-scripts>`_: Regro Conda-Forge autoticker.\n\nJupyter-based interactive notebooks via `xontrib-jupyter <https://github.com/xonsh/xontrib-jupyter>`_:\n\n- `Jupyter and JupyterLab <https://jupyter.org/>`_: Interactive notebook platform.\n- `euporie <https://github.com/joouha/euporie>`_: Terminal based interactive computing environment.\n- `Jupytext <https://jupytext.readthedocs.io/>`_: Clear and meaningful diffs when doing Jupyter notebooks version control.\n\nThe xonsh shell community\n*************************\n\nThe xonsh shell is developed by a community of volunteers. There are a few ways to help out:\n\n- Solve a `popular issue <https://github.com/xonsh/xonsh/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc>`_ or `high priority issue <https://github.com/xonsh/xonsh/issues?q=is%3Aopen+is%3Aissue+label%3Apriority-high+sort%3Areactions-%2B1-desc>`_ or a `good first issue <https://github.com/xonsh/xonsh/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+sort%3Areactions-%2B1-desc>`_. You can start with the `Developer guide <https://xon.sh/devguide.html>`_.\n- Take an `idea <https://github.com/xonsh/xontrib-template/issues?q=is%3Aopen+is%3Aissue+label%3Aidea+sort%3Areactions-%2B1-desc>`_ and `create a new xontrib <https://github.com/xonsh/xontrib-template#why-use-this-template>`_.\n- Contribute to `xonsh API <https://github.com/xonsh/xonsh/tree/main/xonsh/api>`_.\n- Become xonsh core developer by deep diving into xonsh internals. E.g. we feel a lack of Windows support.\n- `Become a sponsor to xonsh <https://github.com/sponsors/xonsh>`_.\n- `Write a tweet`_, post or an article to spread the good word about xonsh in the world.\n- Give a star to xonsh repository and to `xontribs <https://github.com/topics/xontrib>`_ you like.\n\nWe welcome new contributors!\n\n.. _write a tweet: https://twitter.com/intent/tweet?text=xonsh%20is%20a%20Python-powered,%20cross-platform,%20Unix-gazing%20shell%20language%20and%20command%20prompt.&url=https://github.com/xonsh/xonsh\n\nCredits\n*******\n\n- Thanks to `Zulip <https://zulip.com/>`_ for supporting the xonsh community!\n",
"bugtrack_url": null,
"license": "BSD 2-Clause License",
"summary": "Python-powered shell. Full-featured and cross-platform.",
"version": "0.19.1",
"project_urls": {
"Homepage": "https://xon.sh",
"Issue tracker": "https://github.com/xonsh/xonsh/issues",
"changelog": "https://github.com/xonsh/xonsh/blob/main/CHANGELOG.rst",
"documentation": "https://xon.sh/contents.html",
"repository": "https://github.com/xonsh/xonsh"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8ce6db44068c5725af9678e37980ae9503165393d51b80dc8517fa4ec74af1cf",
"md5": "30de8c714743f770ff2a9d9c1ab91f79",
"sha256": "83eb6610ed3535f8542abd80af9554fb7e2805b0b3f96e445f98d4b5cf1f7046"
},
"downloads": -1,
"filename": "xonsh-0.19.1-py310-none-any.whl",
"has_sig": false,
"md5_digest": "30de8c714743f770ff2a9d9c1ab91f79",
"packagetype": "bdist_wheel",
"python_version": "py310",
"requires_python": ">=3.9",
"size": 640686,
"upload_time": "2025-01-13T16:55:39",
"upload_time_iso_8601": "2025-01-13T16:55:39.375025Z",
"url": "https://files.pythonhosted.org/packages/8c/e6/db44068c5725af9678e37980ae9503165393d51b80dc8517fa4ec74af1cf/xonsh-0.19.1-py310-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "774ee487e82349866b245c559433c9ba626026a2e66bd17d7f9ac1045082f146",
"md5": "021d44b5db2d29f29ee85b982012aa07",
"sha256": "c176e515b0260ab803963d1f0924f1e32f1064aa6fd5d791aa0cf6cda3a924ae"
},
"downloads": -1,
"filename": "xonsh-0.19.1-py311-none-any.whl",
"has_sig": false,
"md5_digest": "021d44b5db2d29f29ee85b982012aa07",
"packagetype": "bdist_wheel",
"python_version": "py311",
"requires_python": ">=3.9",
"size": 640680,
"upload_time": "2025-01-13T16:55:40",
"upload_time_iso_8601": "2025-01-13T16:55:40.692228Z",
"url": "https://files.pythonhosted.org/packages/77/4e/e487e82349866b245c559433c9ba626026a2e66bd17d7f9ac1045082f146/xonsh-0.19.1-py311-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5d8809060815548219b8f6953a06c247cb5c92d03cbdf7a02a980bda1b5754db",
"md5": "41fe647a0fc5e08be70089fbae3ebd9c",
"sha256": "fe1266c86b117aced3bdc4d5972420bda715864435d0bd3722d63451e8001036"
},
"downloads": -1,
"filename": "xonsh-0.19.1-py312-none-any.whl",
"has_sig": false,
"md5_digest": "41fe647a0fc5e08be70089fbae3ebd9c",
"packagetype": "bdist_wheel",
"python_version": "py312",
"requires_python": ">=3.9",
"size": 640604,
"upload_time": "2025-01-13T16:55:44",
"upload_time_iso_8601": "2025-01-13T16:55:44.165739Z",
"url": "https://files.pythonhosted.org/packages/5d/88/09060815548219b8f6953a06c247cb5c92d03cbdf7a02a980bda1b5754db/xonsh-0.19.1-py312-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "83ff7873cb8184cffeafddbf861712831c2baa2e9dbecdbfd33b1228f0db0019",
"md5": "af38ed6f884514b97ce8d449f2b25433",
"sha256": "3f158b6fc0bba954e0b989004d4261bafc4bd94c68c2abd75b825da23e5a869c"
},
"downloads": -1,
"filename": "xonsh-0.19.1-py313-none-any.whl",
"has_sig": false,
"md5_digest": "af38ed6f884514b97ce8d449f2b25433",
"packagetype": "bdist_wheel",
"python_version": "py313",
"requires_python": ">=3.9",
"size": 641166,
"upload_time": "2025-01-13T16:55:52",
"upload_time_iso_8601": "2025-01-13T16:55:52.513922Z",
"url": "https://files.pythonhosted.org/packages/83/ff/7873cb8184cffeafddbf861712831c2baa2e9dbecdbfd33b1228f0db0019/xonsh-0.19.1-py313-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cc03b9f8dd338df0a330011d104e63d4d0acd8bbbc1e990ff049487b6bdf585d",
"md5": "1713f9d46b1ebb2e8dfda1026a785a7b",
"sha256": "a900a6eb87d881a7ef90b1ac8522ba3699582f0bcb1e9abd863d32f6d63faf04"
},
"downloads": -1,
"filename": "xonsh-0.19.1-py39-none-any.whl",
"has_sig": false,
"md5_digest": "1713f9d46b1ebb2e8dfda1026a785a7b",
"packagetype": "bdist_wheel",
"python_version": "py39",
"requires_python": ">=3.9",
"size": 632912,
"upload_time": "2025-01-13T16:55:37",
"upload_time_iso_8601": "2025-01-13T16:55:37.405384Z",
"url": "https://files.pythonhosted.org/packages/cc/03/b9f8dd338df0a330011d104e63d4d0acd8bbbc1e990ff049487b6bdf585d/xonsh-0.19.1-py39-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "986eb54a0b2685535995ee50f655103c463f9d339455c9b08c4bce3e03e7bb17",
"md5": "113e311d9fa3f73c7517cd4adca061f3",
"sha256": "5d3de649c909f6d14bc69232219bcbdb8152c830e91ddf17ad169c672397fb97"
},
"downloads": -1,
"filename": "xonsh-0.19.1.tar.gz",
"has_sig": false,
"md5_digest": "113e311d9fa3f73c7517cd4adca061f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 796468,
"upload_time": "2025-01-13T16:55:42",
"upload_time_iso_8601": "2025-01-13T16:55:42.417003Z",
"url": "https://files.pythonhosted.org/packages/98/6e/b54a0b2685535995ee50f655103c463f9d339455c9b08c4bce3e03e7bb17/xonsh-0.19.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-13 16:55:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xonsh",
"github_project": "xonsh",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "xonsh"
}
