Skip to content

Commit 265460e

Browse files
committed
docs: add badges to README
1 parent ab86c1e commit 265460e

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# AbracaTABra
22

3+
[![PyPI](https://img.shields.io/pypi/v/abracatabra.svg)](https://pypi.org/project/abracatabra/)
4+
[![CI](https://github.com/byu-magicc/abracatabra/actions/workflows/ci.yml/badge.svg)](https://github.com/byu-magicc/abracatabra/actions/workflows/ci.yml)
5+
[![Build and publish to PyPI](https://github.com/byu-magicc/abracatabra/actions/workflows/publish.yml/badge.svg)](https://github.com/byu-magicc/abracatabra/actions/workflows/publish.yml)
6+
37
This repository is basically a matplotlib extension using the Qt backend to create plot windows with groups of tabs, where the contents of each tab is a matplotlib figure.
48
This package is essentially a replacement for pyplot; it creates and manages figures separately from pyplot, so calling `pyplot.show()` or `pyplot.pause()` will not do anything with windows created from this package.
59
This package provides the functions `show_all_windows()` and `update_all_windows(delay_seconds)`, which are very similar in behavior to `show()` and `pause(interval)`, respectively, from pyplot.
@@ -9,10 +13,10 @@ Also, `abracatabra()` is a more fun equivalent to `show_all_windows()`...you sho
913

1014
- matplotlib
1115
- One of the following Qt bindings for Python (this is the order matplotlib looks for them):
12-
- PyQt6
13-
- PySide6 (preferred option)
14-
- PyQt5
15-
- PySide2
16+
- PyQt6
17+
- PySide6 (preferred option)
18+
- PyQt5
19+
- PySide2
1620

1721
## Installation
1822

@@ -29,6 +33,7 @@ A Python Qt package is required for functionality, but there is no good way to h
2933
- [qt-pyqt6]
3034

3135
For example, run this to install PySide6 along with this package:
36+
3237
```
3338
pip install "abracatabra[qt-pyside6]"
3439
```

0 commit comments

Comments
 (0)