mirrors/xonsh
1
0
Fork 0
mirror of https://github.com/xonsh/xonsh.git synced 2025-03-04 08:24:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
xonsh/README.rst

66 lines
3.2 KiB
ReStructuredText
Raw Normal View History

text
2020-10-19 23:06:00 +03:00
xonsh
=====
Fix readme and rever test call for release (#4075) The rever command hasn't been tested with the new parameters to `run-tests.xsh` (spoiler alert, it breaks). Also converted the `raw` block to regular RST since PyPI doesn't allow `raw` directives in the `long_description` on upload to PyPI
2021-02-04 11:45:37 -05:00
.. 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.
add py310 (#4270) * chore: adding py310 to ci though this will require code/parser changes, this is to prepare for upcoming adoption * fix: set python version as string * fix: reference to master -> main * fix: coverage is not reported in master - disable amalgamation 1. during coverage report tests 2. qa tools like mypy may follow imports - use python 3.9 for coverage and qa report. since it will have more coverage and better typing support * chore: use py3.10 with setup-py action * chore: add news-item check job * fix: py3.10 error while starting the match statement is not supported. while the syntax support is only upto py3.8 * fix: news-item checker * chore: enable fail report for py310 tests * test: add test for ptk_shell
2021-06-07 23:10:40 +05:30
.. image:: https://raw.githubusercontent.com/xonsh/xonsh/main/docs/_static/xonsh5.png
Fix readme and rever test call for release (#4075) The rever command hasn't been tested with the new parameters to `run-tests.xsh` (spoiler alert, it breaks). Also converted the `raw` block to regular RST since PyPI doesn't allow `raw` directives in the `long_description` on upload to PyPI
2021-02-04 11:45:37 -05:00
: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
add py310 (#4270) * chore: adding py310 to ci though this will require code/parser changes, this is to prepare for upcoming adoption * fix: set python version as string * fix: reference to master -> main * fix: coverage is not reported in master - disable amalgamation 1. during coverage report tests 2. qa tools like mypy may follow imports - use python 3.9 for coverage and qa report. since it will have more coverage and better typing support * chore: use py3.10 with setup-py action * chore: add news-item check job * fix: py3.10 error while starting the match statement is not supported. while the syntax support is only upto py3.8 * fix: news-item checker * chore: enable fail report for py310 tests * test: add test for ptk_shell
2021-06-07 23:10:40 +05:30
.. image:: https://travis-ci.org/xonsh/xonsh.svg?branch=main
Fix readme and rever test call for release (#4075) The rever command hasn't been tested with the new parameters to `run-tests.xsh` (spoiler alert, it breaks). Also converted the `raw` block to regular RST since PyPI doesn't allow `raw` directives in the `long_description` on upload to PyPI
2021-02-04 11:45:37 -05:00
: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
Small docs fixes (#4124) * button * transparent png * transparent png * github xontribs * transparent png * moving windows note * removing broken link * talks added * talks added Co-authored-by: a <a>
2021-03-01 18:44:17 +03:00
.. image:: https://img.shields.io/badge/Google%20Cloud%20Shell-xonsh-green
Fix readme and rever test call for release (#4075) The rever command hasn't been tested with the new parameters to `run-tests.xsh` (spoiler alert, it breaks). Also converted the `raw` block to regular RST since PyPI doesn't allow `raw` directives in the `long_description` on upload to PyPI
2021-02-04 11:45:37 -05:00
:target: https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://github.com/xonsh/xonsh.git
Small docs fixes (#4124) * button * transparent png * transparent png * github xontribs * transparent png * moving windows note * removing broken link * talks added * talks added Co-authored-by: a <a>
2021-03-01 18:44:17 +03:00
:alt: Open in Google Cloud Shell
Jnoortheen patch 1 (#4451) * add codecov badge * Update README.rst
2021-08-30 23:42:08 +05:30
.. 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
codecov badge in README
2017-01-29 17:01:23 +02:00
readme
2020-10-18 03:37:35 +03:00
First steps
***********
Update README.rst
2020-09-23 09:19:53 +03:00
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.
Small docs fixes (#4124) * button * transparent png * transparent png * github xontribs * transparent png * moving windows note * removing broken link * talks added * talks added Co-authored-by: a <a>
2021-03-01 18:44:17 +03:00
- `Xontribs <https://xon.sh/xontribs.html>`_ or `Github Xontribs <https://github.com/topics/xontrib>`_ - list of awesome xonsh extensions.
Add 'Projects that use xonsh' section to README
2016-05-14 18:59:14 -04:00
Projects that use xonsh
***********************
- `gitsome <https://github.com/donnemartin/gitsome>`_: A supercharged Git/shell autocompleter with GitHub integration.
update projects
2018-10-01 20:39:50 +01:00
- `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.
readme twitter
2020-10-22 17:01:04 +03:00
- `xxh <https://github.com/xxh/xxh>`_: Using xonsh wherever you go through the ssh.
Fix readme and rever test call for release (#4075) The rever command hasn't been tested with the new parameters to `run-tests.xsh` (spoiler alert, it breaks). Also converted the `raw` block to regular RST since PyPI doesn't allow `raw` directives in the `long_description` on upload to PyPI
2021-02-04 11:45:37 -05:00
docs: add "The xonsh shell community" to the readme (#4585) * docs: add "The xonsh shell community" to the readme * docs: fix spelling Co-authored-by: Gil Forsyth <gforsyth@users.noreply.github.com> Co-authored-by: Gil Forsyth <gforsyth@users.noreply.github.com>
2021-12-03 17:39:19 +03:00
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!
Fix readme and rever test call for release (#4075) The rever command hasn't been tested with the new parameters to `run-tests.xsh` (spoiler alert, it breaks). Also converted the `raw` block to regular RST since PyPI doesn't allow `raw` directives in the `long_description` on upload to PyPI
2021-02-04 11:45:37 -05:00
.. _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
Reference in a new issue Copy permalink