mirror of
https://github.com/xonsh/xonsh.git
synced 2025-03-04 16:34:47 +01:00
🐚 Python-powered shell. Full-featured and cross-platform.
artificial-intelligencebashclicommand-lineconsoledata-engineeringdata-sciencedevopsfishiterm2pythonraspberry-pisecurity-automationshellxonshzsh
81c8fe6bb9
* make env_name aware of prompt in pyvenv.cfg prompt.env.env_name is now aware of the "prompt" key in pyvenv.cfg - search order from first to last is: $VIRTUAL_ENV_PROMPT, pyvenv.cfg, $VIRTUAL_ENV. fixes #4670 * make env_name aware of prompt in pyvenv.cfg prompt.env.env_name is now aware of the "prompt" key in pyvenv.cfg - search order from first to last is: $VIRTUAL_ENV_PROMPT, pyvenv.cfg, $VIRTUAL_ENV. As the env_name is generated every time the prompt is generated, caching is used to only calculate it once for every venv path. This introduces the possibility that the user will not get a correct env_name, when they change the cfg file or replace the whole venv and use different prompt settings the second time around. Although this is annoying and potentially confusing, it is still better than the situation before, where the prompt setting was simply ignored, although it is part of venv since python3.6 - so or now this might be seen as acceptable trade-off between speed and correctness. fixes #4670 * make env_name aware of prompt in pyvenv.cfg prompt.env.env_name is now aware of the "prompt" key in pyvenv.cfg - search order from first to last is: $VIRTUAL_ENV_PROMPT, pyvenv.cfg, $VIRTUAL_ENV. As the env_name is generated every time the prompt is generated, caching is used to only calculate it once for every venv path. This introduces the possibility that the user will not get a correct env_name, when they change the cfg file or replace the whole venv and use different prompt settings the second time around. Although this is annoying and potentially confusing, it is still better than the situation before, where the prompt setting was simply ignored, although it is part of venv since python3.6 - so or now this might be seen as acceptable trade-off between speed and correctness. fixes #4670 * add type annotations * always return str This is more consistent and might also deal with a mypy error only observed on Ubuntu Linux python3.9 * remove unnecessary import * adapt code to not break the documented API When restructuring the code, I did not know that this was part of a documented API. This restores the API functions and updates the doc strings. New helper functions have been made private. |
||
|---|---|---|
| .github | ||
| appimage | ||
| ci | ||
| docs | ||
| news | ||
| requirements | ||
| scripts | ||
| tests | ||
| xompletions | ||
| xonsh | ||
| xontrib | ||
| .authors.yml | ||
| .coveragerc | ||
| .gitattributes | ||
| .gitignore | ||
| .mailmap | ||
| .pre-commit-config.yaml | ||
| amalgamate.py | ||
| AUTHORS.rst | ||
| CHANGELOG.rst | ||
| conftest.py | ||
| CONTRIBUTING.rst | ||
| github_deploy_key.enc | ||
| license | ||
| logo.txt | ||
| Makefile | ||
| MANIFEST.in | ||
| pyproject.toml | ||
| README.rst | ||
| release.xsh | ||
| rever.xsh | ||
| run-tests.xsh | ||
| scent.py | ||
| setup.cfg | ||
| setup.py | ||
| xonsh-in-docker.py | ||
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
First steps
***********
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.
- `Xontribs <https://xon.sh/xontribs.html>`_ or `Github Xontribs <https://github.com/topics/xontrib>`_ - list of awesome xonsh extensions.
Projects that use xonsh
***********************
- `gitsome <https://github.com/donnemartin/gitsome>`_: A supercharged Git/shell autocompleter with GitHub integration.
- `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.
- `xxh <https://github.com/xxh/xxh>`_: Using xonsh wherever you go through the ssh.
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 two major ways to help the xonsh shell: to spread the good word about xonsh in the world (`write a tweet`_) and to help improve the xonsh shell (`solve an issue <https://github.com/xonsh/xonsh/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc>`_). 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