xonsh


Namexonsh JSON
Version 0.16.0 PyPI version JSON
download
home_pageNone
SummaryPython-powered, cross-platform, Unix-gazing shell
upload_time2024-04-23 18:36:07
maintainerAnthony Scopatz
docs_urlNone
authorAnthony Scopatz
requires_python>=3.9
licenseBSD 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, cross-platform, Unix-gazing shell language and command prompt.

    The language is a superset of Python 3.6+ with additional shell primitives.
    xonsh (pronounced *conch*) is meant for the daily use of experts and novices alike.

    .. image:: https://raw.githubusercontent.com/xonsh/xonsh/main/docs/_static/what_is_xonsh.png
            :alt: What is xonsh?
            :align: center

.. class:: center

    If you like xonsh, :star: the repo, `write a tweet`_ and stay tuned by watching releases.

    .. image:: https://badges.gitter.im/xonsh/xonsh.svg
            :target: https://gitter.im/xonsh/xonsh?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
            :alt: Join the chat at https://gitter.im/xonsh/xonsh

    .. image:: https://travis-ci.org/xonsh/xonsh.svg?branch=main
            :target: https://travis-ci.org/xonsh/xonsh
            :alt: Travis

    .. image:: https://ci.appveyor.com/api/projects/status/github/xonsh/xonsh?svg=true
            :target: https://ci.appveyor.com/project/xonsh/xonsh
            :alt: Appveyor

    .. image:: https://img.shields.io/badge/Google%20Cloud%20Shell-xonsh-green
            :target: https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://github.com/xonsh/xonsh.git
            :alt: Open in Google Cloud Shell
    .. 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 the certain term for extensions and additional materials - xontrib - the short version of "contribution" word.

- `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
*************************************

- `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.
- `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.
- `zoxide <https://github.com/ajeetdsouza/zoxide>`_: A smarter cd command.
- `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.

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.

The xonsh shell community
*************************

The xonsh shell is developed by a community of volunteers. There are few ways to help the xonsh shell:

- Solve a `popular issue <https://github.com/xonsh/xonsh/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc>`_. You can start with the `Developer guide <https://xon.sh/devguide.html>`_.
- Solve 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>`_.
- Get the `idea <https://github.com/xonsh/xontrib-template/issues?q=is%3Aopen+is%3Aissue+label%3Aidea+sort%3Areactions-%2B1-desc>`_ and `create new xontrib <https://github.com/xonsh/xontrib-template#why-use-this-template>`_.
- Become xonsh core by deep diving into xonsh and improve the threading and subprocess logic.
- `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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "xonsh",
    "maintainer": "Anthony Scopatz",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "scopatz@gmail.com",
    "keywords": null,
    "author": "Anthony Scopatz",
    "author_email": "scopatz@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/bf/10/768d42e8eaaad61c68204ed2f062bc289f79d1bb9a4737e0623919dde33c/xonsh-0.16.0.tar.gz",
    "platform": "Cross Platform",
    "description": "xonsh\n=====\n\n.. class:: center\n\n    **xonsh** is a Python-powered, cross-platform, Unix-gazing shell language and command prompt.\n\n    The language is a superset of Python 3.6+ with additional shell primitives.\n    xonsh (pronounced *conch*) is meant for the daily use of experts and novices alike.\n\n    .. image:: https://raw.githubusercontent.com/xonsh/xonsh/main/docs/_static/what_is_xonsh.png\n            :alt: What is xonsh?\n            :align: center\n\n.. class:: center\n\n    If you like xonsh, :star: the repo, `write a tweet`_ and stay tuned by watching releases.\n\n    .. image:: https://badges.gitter.im/xonsh/xonsh.svg\n            :target: https://gitter.im/xonsh/xonsh?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge\n            :alt: Join the chat at https://gitter.im/xonsh/xonsh\n\n    .. image:: https://travis-ci.org/xonsh/xonsh.svg?branch=main\n            :target: https://travis-ci.org/xonsh/xonsh\n            :alt: Travis\n\n    .. image:: https://ci.appveyor.com/api/projects/status/github/xonsh/xonsh?svg=true\n            :target: https://ci.appveyor.com/project/xonsh/xonsh\n            :alt: Appveyor\n\n    .. image:: https://img.shields.io/badge/Google%20Cloud%20Shell-xonsh-green\n            :target: https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://github.com/xonsh/xonsh.git\n            :alt: Open in Google Cloud Shell\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    .. image:: https://repology.org/badge/tiny-repos/xonsh.svg\n            :target: https://repology.org/project/xonsh/versions\n            :alt: repology.org\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 the certain term for extensions and additional materials - xontrib - the short version of \"contribution\" word.\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- `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- `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- `zoxide <https://github.com/ajeetdsouza/zoxide>`_: A smarter cd command.\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\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\nThe xonsh shell community\n*************************\n\nThe xonsh shell is developed by a community of volunteers. There are few ways to help the xonsh shell:\n\n- Solve a `popular issue <https://github.com/xonsh/xonsh/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc>`_. You can start with the `Developer guide <https://xon.sh/devguide.html>`_.\n- Solve 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>`_.\n- Get the `idea <https://github.com/xonsh/xontrib-template/issues?q=is%3Aopen+is%3Aissue+label%3Aidea+sort%3Areactions-%2B1-desc>`_ and `create new xontrib <https://github.com/xonsh/xontrib-template#why-use-this-template>`_.\n- Become xonsh core by deep diving into xonsh and improve the threading and subprocess logic.\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",
    "bugtrack_url": null,
    "license": "BSD 2-Clause License",
    "summary": "Python-powered, cross-platform, Unix-gazing shell",
    "version": "0.16.0",
    "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": "0ff7dfd38e221b794d30508141724ea9a596d34fcfbeac8411c1326048af25e2",
                "md5": "410e505dabbc7fdf124ffbbc66f81f71",
                "sha256": "d451f024d58eeac99f4060043066bf733a814430321f0bc5e80ecf15d4812f5a"
            },
            "downloads": -1,
            "filename": "xonsh-0.16.0-py310-none-any.whl",
            "has_sig": false,
            "md5_digest": "410e505dabbc7fdf124ffbbc66f81f71",
            "packagetype": "bdist_wheel",
            "python_version": "py310",
            "requires_python": ">=3.9",
            "size": 623649,
            "upload_time": "2024-04-23T18:36:05",
            "upload_time_iso_8601": "2024-04-23T18:36:05.909223Z",
            "url": "https://files.pythonhosted.org/packages/0f/f7/dfd38e221b794d30508141724ea9a596d34fcfbeac8411c1326048af25e2/xonsh-0.16.0-py310-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ba1cf4d048756e05dcdf72e4fe8e3868d6d06c3ed4650f261e81c35605d805ac",
                "md5": "495e6314690a190821ece7ea47dfbf80",
                "sha256": "2e5cf62d45922e547685576b870a3245f8b0b1b47fbcce0086dd2f672de5e3ea"
            },
            "downloads": -1,
            "filename": "xonsh-0.16.0-py311-none-any.whl",
            "has_sig": false,
            "md5_digest": "495e6314690a190821ece7ea47dfbf80",
            "packagetype": "bdist_wheel",
            "python_version": "py311",
            "requires_python": ">=3.9",
            "size": 623639,
            "upload_time": "2024-04-23T18:36:05",
            "upload_time_iso_8601": "2024-04-23T18:36:05.222194Z",
            "url": "https://files.pythonhosted.org/packages/ba/1c/f4d048756e05dcdf72e4fe8e3868d6d06c3ed4650f261e81c35605d805ac/xonsh-0.16.0-py311-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fa214bc1f8c8fe942e7b4564a0d8bbf3cf4cb72247bcf9f005fbcb37fcae23aa",
                "md5": "c938d8d5fa98aa1848fb39ea89dd991f",
                "sha256": "4464fe038ea20751673405bbec21d2fc36b50c3867c7d6934640d7064f823458"
            },
            "downloads": -1,
            "filename": "xonsh-0.16.0-py312-none-any.whl",
            "has_sig": false,
            "md5_digest": "c938d8d5fa98aa1848fb39ea89dd991f",
            "packagetype": "bdist_wheel",
            "python_version": "py312",
            "requires_python": ">=3.9",
            "size": 623619,
            "upload_time": "2024-04-23T18:35:57",
            "upload_time_iso_8601": "2024-04-23T18:35:57.160398Z",
            "url": "https://files.pythonhosted.org/packages/fa/21/4bc1f8c8fe942e7b4564a0d8bbf3cf4cb72247bcf9f005fbcb37fcae23aa/xonsh-0.16.0-py312-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e4cbb26570507b7c2460dd20dde2b9f7aaec4f5437826112f49d8dcd02035f3c",
                "md5": "983dd3ce0aa42b7c8e526bc941391aab",
                "sha256": "70322447979f8a6184e2939a8da64ffe89a603e8c1312a76b6d09b36b1dcc12e"
            },
            "downloads": -1,
            "filename": "xonsh-0.16.0-py39-none-any.whl",
            "has_sig": false,
            "md5_digest": "983dd3ce0aa42b7c8e526bc941391aab",
            "packagetype": "bdist_wheel",
            "python_version": "py39",
            "requires_python": ">=3.9",
            "size": 615865,
            "upload_time": "2024-04-23T18:35:56",
            "upload_time_iso_8601": "2024-04-23T18:35:56.739363Z",
            "url": "https://files.pythonhosted.org/packages/e4/cb/b26570507b7c2460dd20dde2b9f7aaec4f5437826112f49d8dcd02035f3c/xonsh-0.16.0-py39-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bf10768d42e8eaaad61c68204ed2f062bc289f79d1bb9a4737e0623919dde33c",
                "md5": "af7a786d83106bc9211b63a52fa092f8",
                "sha256": "087be3080082f7464960663809472f96ea4ca2a95631623c28ba50a8d1879e7b"
            },
            "downloads": -1,
            "filename": "xonsh-0.16.0.tar.gz",
            "has_sig": false,
            "md5_digest": "af7a786d83106bc9211b63a52fa092f8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 773159,
            "upload_time": "2024-04-23T18:36:07",
            "upload_time_iso_8601": "2024-04-23T18:36:07.953492Z",
            "url": "https://files.pythonhosted.org/packages/bf/10/768d42e8eaaad61c68204ed2f062bc289f79d1bb9a4737e0623919dde33c/xonsh-0.16.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-23 18:36:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "xonsh",
    "github_project": "xonsh",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "xonsh"
}
        
Elapsed time: 0.26554s