Skip to content

Commit f9d06ba

Browse files
Mjboothausoz-agent
andcommitted
docs: add badges and polish release announcements
Co-Authored-By: Oz <oz-agent@warp.dev>
1 parent 5d97ef7 commit f9d06ba

3 files changed

Lines changed: 41 additions & 3 deletions

File tree

README.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# pytest-just
22
A pytest plugin for testing justfiles.
3+
[![CI](https://github.com/DataBooth/pytest-just/actions/workflows/ci.yml/badge.svg)](https://github.com/DataBooth/pytest-just/actions/workflows/ci.yml)
4+
[![PyPI version](https://img.shields.io/pypi/v/pytest-just.svg)](https://pypi.org/project/pytest-just/)
5+
[![Python versions](https://img.shields.io/pypi/pyversions/pytest-just.svg)](https://pypi.org/project/pytest-just/)
6+
[![License: MIT](https://img.shields.io/pypi/l/pytest-just.svg)](https://github.com/DataBooth/pytest-just/blob/main/LICENSE)
7+
8+
## Package status
9+
`pytest-just` is published on PyPI.
10+
11+
- PyPI: https://pypi.org/project/pytest-just/
12+
- Source: https://github.com/DataBooth/pytest-just
13+
- Latest release notes: `RELEASE_NOTES.md`
314
## What is pytest-just?
415
`pytest-just` is a plugin that adds a session-scoped `just` fixture to pytest so you can test `justfile` contracts directly in your test suite.
516

@@ -28,11 +39,34 @@ This catches automation drift early without requiring full end-to-end execution
2839
- Lint/format checks: `ruff`
2940
- Type checks: `ty`
3041
- Logging: `loguru`
42+
## Install from PyPI
43+
Add `pytest-just` to your test dependencies:
44+
45+
```bash
46+
uv add --dev pytest-just
47+
```
48+
49+
You also need the `just` binary available in your environment:
50+
51+
```bash
52+
just --version
53+
```
54+
55+
## Quick start (package usage)
56+
Create tests that use the plugin fixture:
3157

32-
## Quick start
58+
```python
59+
import pytest
60+
61+
@pytest.mark.justfile
62+
def test_ci_depends_on_test(just):
63+
just.assert_exists("ci")
64+
just.assert_depends_on("ci", ["test"], transitive=True)
65+
```
66+
67+
Run:
3368
```bash
34-
uv sync
35-
uv run pytest
69+
uv run pytest -q
3670
```
3771
## How does pytest-just work?
3872
`pytest-just` primarily validates recipe contracts instead of running full recipe side effects. It asks `just` for structured metadata and rendered recipe text:
@@ -94,6 +128,7 @@ Sample real-world-inspired justfiles live under `examples/public/` and include:
94128
Use them to exercise fixture behaviour while developing the plugin.
95129

96130
## Development workflow
131+
If you are contributing to this repository:
97132
```bash
98133
uv sync --extra dev
99134
uv run ruff check .

docs/announcements/linkedin_announcement.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ Built with:
1717
If you use `just` in your workflow, I’d value your feedback on what should come next.
1818

1919
Repo: https://github.com/DataBooth/pytest-just
20+
PyPI: https://pypi.org/project/pytest-just/0.1.2/

docs/announcements/release_announcement.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,7 @@ Highlights in this release:
1717
- CI checks on pull requests and `main` branch pushes
1818

1919
Repository: https://github.com/DataBooth/pytest-just
20+
PyPI: https://pypi.org/project/pytest-just/0.1.2/
21+
Release: https://github.com/DataBooth/pytest-just/releases/tag/v0.1.2
2022

2123
Feedback, issues, and contributions are very welcome.

0 commit comments

Comments
 (0)