Skip to content

Commit 6bf128f

Browse files
committed
docs: add logo, center header and badges, fix code blocks
Added assertpy2 SVG logo. Centered title, tagline and badges. Fixed code block syntax highlighting for error output examples. Merged bare assert comparison into a single code block.
1 parent 95d434a commit 6bf128f

2 files changed

Lines changed: 21 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
1-
# assertpy2
1+
<p align="center">
2+
<img src="docs/logo.svg" alt="assertpy2" width="280">
3+
</p>
24

3-
Fluent assertion library for Python with full type safety and soft assertions. Maintained fork of [assertpy](https://github.com/assertpy/assertpy).
5+
<p align="center">
6+
Fluent assertion library for Python with full type safety and soft assertions.<br>
7+
Maintained fork of <a href="https://github.com/assertpy/assertpy">assertpy</a>.
8+
</p>
49

5-
[![CI](https://github.com/Solganis/assertpy2/actions/workflows/ci.yml/badge.svg)](https://github.com/Solganis/assertpy2/actions/workflows/ci.yml)
6-
[![PyPI version](https://img.shields.io/pypi/v/assertpy2)](https://pypi.org/project/assertpy2/)
7-
[![Downloads](https://static.pepy.tech/badge/assertpy2/month)](https://pepy.tech/projects/assertpy2)
8-
[![Python](https://img.shields.io/pypi/pyversions/assertpy2)](https://pypi.org/project/assertpy2/)
9-
[![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)](https://github.com/Solganis/assertpy2)
10-
[![License](https://img.shields.io/github/license/Solganis/assertpy2)](https://github.com/Solganis/assertpy2/blob/main/LICENSE)
10+
<p align="center">
11+
<a href="https://github.com/Solganis/assertpy2/actions/workflows/ci.yml"><img src="https://github.com/Solganis/assertpy2/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
12+
<a href="https://pypi.org/project/assertpy2/"><img src="https://img.shields.io/pypi/v/assertpy2" alt="PyPI version"></a>
13+
<a href="https://pepy.tech/projects/assertpy2"><img src="https://static.pepy.tech/badge/assertpy2/month" alt="Downloads"></a>
14+
<a href="https://pypi.org/project/assertpy2/"><img src="https://img.shields.io/pypi/pyversions/assertpy2" alt="Python"></a>
15+
<a href="https://github.com/Solganis/assertpy2"><img src="https://img.shields.io/badge/coverage-100%25-brightgreen" alt="Coverage"></a>
16+
<a href="https://github.com/Solganis/assertpy2/blob/main/LICENSE"><img src="https://img.shields.io/github/license/Solganis/assertpy2" alt="License"></a>
17+
</p>
1118

1219

1320
## Quick start
@@ -30,7 +37,7 @@ def test_user():
3037

3138
When an assertion fails, the error message tells you exactly what went wrong:
3239

33-
```
40+
```py
3441
assert_that(user["age"]).is_between(50, 120)
3542
# AssertionError: Expected <30> to be between <50> and <120>, but was not.
3643

@@ -49,9 +56,7 @@ assert user["age"] >= 18
4956
# assertpy2 - same check, clear failure message
5057
assert_that(user["age"]).is_greater_than_or_equal_to(18)
5158
# AssertionError: Expected <16> to be greater than or equal to <18>, but was not.
52-
```
5359

54-
```py
5560
# bare assert - three separate statements
5661
assert isinstance(items, list)
5762
assert len(items) == 3

‎docs/logo.svg‎

Lines changed: 5 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)