Skip to content

Commit

Permalink
Merge branch 'master' into richhandler-suppress
Browse files Browse the repository at this point in the history
  • Loading branch information
willmcgugan committed Feb 27, 2022
2 parents 201b7f3 + 71135d1 commit 75f4637
Show file tree
Hide file tree
Showing 24 changed files with 374 additions and 721 deletions.
4 changes: 0 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request.md
Expand Up @@ -18,7 +18,3 @@ Give as much detail as you can. Example code of how you would like it to work wo
**What problem does it solve for you?**

What problem do you have that this feature would solve? I may be able to suggest an existing way of solving it.

**Did I help**

If I was able to resolve your problem, consider [sponsoring](https://github.com/sponsors/willmcgugan) my work on Rich, or [buy me a coffee](https://ko-fi.com/willmcgugan) to say thanks.
308 changes: 156 additions & 152 deletions CHANGELOG.md

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions CONTRIBUTORS.md
Expand Up @@ -7,6 +7,7 @@ The following people have contributed to the development of Rich:
- [Patrick Arminio](https://github.com/patrick91)
- [Gregory Beauregard](https://github.com/GBeauregard/pyffstream)
- [Darren Burns](https://github.com/darrenburns)
- [Ed Davis](https://github.com/davised)
- [Pete Davison](https://github.com/pd93)
- [James Estevez](https://github.com/jstvz)
- [Oleksis Fraga](https://github.com/oleksis)
Expand All @@ -28,7 +29,9 @@ The following people have contributed to the development of Rich:
- [Tushar Sadhwani](https://github.com/tusharsadhwani)
- [Tim Savage](https://github.com/timsavage)
- [Nicolas Simonds](https://github.com/0xDEC0DE)
- [Aaron Stephens](https://github.com/aaronst)
- [Gabriele N. Tornetta](https://github.com/p403n1x87)
- [Dennis Brakhane](https://github.com/brakhane)
- [Michał Górny](https://github.com/mgorny)
- [Arian Mollik Wasi](https://github.com/wasi-master)
- [Brian Rutledge](https://github.com/bhrutledge)
2 changes: 2 additions & 0 deletions docs/source/highlighting.rst
@@ -1,3 +1,5 @@
.. _highlighting:

Highlighting
============

Expand Down
12 changes: 6 additions & 6 deletions docs/source/introduction.rst
@@ -1,7 +1,7 @@
Introduction
============

Rich is a Python library for writing *rich* text (with color and style) to the terminal, and for displaying advanced content such as tables, markdown, and syntax highlighted code.
Rich is a Python library for writing *rich* text (with color and style) to the terminal, and for displaying advanced content such as tables, markdown, and syntax highlighted code.

Use Rich to make your command line applications visually appealing and present data in a more readable way. Rich can also be a useful debugging aid by pretty printing and syntax highlighting data structures.

Expand Down Expand Up @@ -38,7 +38,7 @@ The quickest way to get up and running with Rich is to import the alternative ``

from rich import print

You can then print strings or objects to the terminal in the usual way. Rich will do some basic syntax highlighting and format data structures to make them easier to read.
You can then print strings or objects to the terminal in the usual way. Rich will do some basic syntax :ref:`highlighting<highlighting>` and format data structures to make them easier to read.

Strings may contain :ref:`console_markup` which can be used to insert color and styles in to the output.

Expand All @@ -50,7 +50,7 @@ This writes the following output to the terminal (including all the colors and s

.. raw:: html

<pre style="font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace"><span style="color: #800000; font-style: italic">Hello</span> World!
<pre style="font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace"><span style="color: #800000; font-style: italic">Hello</span> World!
<span style="font-weight: bold">{</span>
<span style="color: #008000">'__annotations__'</span>: <span style="font-weight: bold">{}</span>,
<span style="color: #008000">'__builtins__'</span>: <span style="font-weight: bold"><</span><span style="color: #ff00ff">module</span><span style="color: #000000"> </span><span style="color: #008000">'builtins'</span><span style="color: #000000"> </span><span style="color: #000000; font-weight: bold">(</span><span style="color: #000000">built-in</span><span style="color: #000000; font-weight: bold">)</span><span style="font-weight: bold">></span>,
Expand All @@ -75,7 +75,7 @@ Rich in the REPL
Rich may be installed in the REPL so that Python data structures are automatically pretty printed with syntax highlighting. Here's how::

>>> from rich import pretty
>>> pretty.install()
>>> pretty.install()
>>> ["Rich and pretty", True]

You can also use this feature to try out Rich *renderables*. Here's an example::
Expand All @@ -91,8 +91,8 @@ IPython Extension
Rich also includes an IPython extension that will do this same pretty install + pretty tracebacks. Here's how to load it::

In [1]: %load_ext rich
You can also have it load by default by adding `"rich"` to the ``c.InteractiveShellApp.extension`` variable in

You can also have it load by default by adding `"rich"` to the ``c.InteractiveShellApp.extension`` variable in
`IPython Configuration <https://ipython.readthedocs.io/en/stable/config/intro.html>`_.

Rich Inspect
Expand Down
Binary file modified imgs/downloader.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
70 changes: 1 addition & 69 deletions imgs/logo.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified imgs/progress.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified imgs/spinners.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified imgs/status.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified imgs/traceback.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
70 changes: 35 additions & 35 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Expand Up @@ -41,7 +41,7 @@ jupyter = ["ipywidgets"]
[tool.poetry.dev-dependencies]
pytest = "^7.0.0"
black = "^22.1"
mypy = "^0.930"
mypy = "^0.931"
pytest-cov = "^3.0.0"
attrs = "^21.4.0"
types-dataclasses = "^0.6.4"
Expand Down

0 comments on commit 75f4637

Please sign in to comment.