Skip to content

Commit

Permalink
docs: badges and a warning
Browse files Browse the repository at this point in the history
  • Loading branch information
15r10nk committed Oct 8, 2023
1 parent 5738638 commit cc0847d
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
[![pypi version](https://img.shields.io/pypi/v/pysource-minimize.svg)](https://pypi.org/project/pysource-minimize/)
![Python Versions](https://img.shields.io/pypi/pyversions/pysource-minimize)
![PyPI - Downloads](https://img.shields.io/pypi/dw/pysource-minimize)
[![GitHub Sponsors](https://img.shields.io/github/sponsors/15r10nk)](https://github.com/sponsors/15r10nk)

# pysource-minimize

If you build a linter, formatter or any other tool which has to analyse python source code you might end up searching bugs in pretty large input files.
Expand All @@ -15,8 +20,15 @@ pysource-minimize --file bug.py --track "Assertion" -- python bug.py
This will run `python bug.py` and try to find the string "Assertion" in the output.
The `--file bug.py` gets minimized as long as "Assertion" is part of the output of the command.

> [!WARNING]
> Be careful when you execute code which gets minimized.
> It might be that some combination of the code you minimize erases your hard drive
> or does other unintended things.
![example](example.gif)



## API
Example:
``` pycon
Expand Down

0 comments on commit cc0847d

Please sign in to comment.