mirror of
https://github.com/xonsh/xonsh.git
synced 2025-03-04 00:14:41 +01:00
572331700b
* fix: load autoloading (but not yet autoloaded) xontribs Xontrib template creates autoloaded xontribs in a `xontrib_X` folder instad of a `xontib/X.py`file, so you can't 'xontrib load X' right after you install them, which breaks pytests * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
95 lines
4.5 KiB
ReStructuredText
95 lines
4.5 KiB
ReStructuredText
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/xonsh5.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://img.shields.io/badge/%23xonsh%3Afeneas.org-Matrix-green
|
|
:target: https://matrix.to/#/#xonsh:feneas.org
|
|
:alt: Matrix room: #xonsh:feneas.org
|
|
|
|
.. 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.
|
|
|
|
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 and has no organization that can get grants, donations or additional support. There are few ways to help the xonsh shell:
|
|
|
|
- `Write a tweet`_, post or an article to spread the good word about xonsh in the world.
|
|
- Solve a `popular issue <https://github.com/xonsh/xonsh/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc>`_.
|
|
- 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.
|
|
|
|
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
|