Skip to content

Commit

Permalink
README: misc cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
dtrifiro committed Nov 20, 2023
1 parent 5da9094 commit 075b32b
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: pytest-fzf
---
# pytest-fzf

[![PyPI version](https://img.shields.io/pypi/v/pytest-fzf.svg)](https://pypi.org/project/pytest-fzf)
[![Python versions](https://img.shields.io/pypi/pyversions/pytest-fzf.svg)](https://pypi.org/project/pytest-fzf)
Expand All @@ -12,17 +10,16 @@ fzf-based test selection with `pytest`

---

# Features
## Features

- Select tests to be run with pytest using fzf

# Requirements
## Requirements

- [fzf](https://github.com/junegunn/fzf)
- (Optional, for colored preview of test functions) [`bat`](https://github.com/sharkdp/bat)
(<https://github.com/sharkdp/bat>)
- (Optional, for colored preview of test functions) `bat`[sharkdp/bat](https://github.com/sharkdp/bat)

# Installation
## Installation

You can install `pytest-fzf` via [pip](https://pypi.org/project/pip/)
from [PyPI](https://pypi.org/project):
Expand All @@ -31,7 +28,7 @@ from [PyPI](https://pypi.org/project):
pip install pytest-fzf
```

# Usage
## Usage

```bash
pytest --fzf [query]
Expand All @@ -46,19 +43,19 @@ Optionally, the initial query can be specified from the command line:
pytest --fzf query
```

# Contributing
## Contributing

Contributions are very welcome. Tests can be run with
[nox](https://github.com/wntrblm/nox), please ensure the coverage at
least stays the same before you submit a pull request.

# License
## License

Distributed under the terms of the [GNU GPL
v3.0](http://www.gnu.org/licenses/gpl-3.0.txt) license, `pytest-fzf`
is free and open source software

# Issues
## Issues

If you encounter any problems, please [file an
issue](https://github.com/dtrifiro/pytest-fzf/issues) along with a
Expand Down

0 comments on commit 075b32b

Please sign in to comment.