Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cvzi authored Mar 22, 2023
1 parent ac9f340 commit f394435
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
# requirements
# requirements.py
Find updates for packages in requirements.txt on pypi

![Screenrecord](https://github.com/cvzi/requirements/raw/screenshots/video.png)

## Usage

Run `requirements.py` in a folder that contains a `requirements.txt`
You can use the file [requirements.py](https://github.com/cvzi/requirements/blob/main/requirements/requirements.py), simply
run `requirements.py` in a folder that contains a `requirements.txt`

Or run `requirements.py path/to/first/requirements.txt path/to/second/requirements.txt`

![Screenrecord](https://github.com/cvzi/requirements/raw/screenshots/video.png)

Once installed the module can be used directly with `requirements` or `python -m requirements`.
You can also install the module with its dependencies from [pypi.org](https://pypi.org/project/requirements.py/):

```sh
pip install requirements.py
```

Once installed the module can be used directly with `python -m requirements` or the command `requirements`.

It also offers some functions to query pypi and requirements.txt programmatically:

Expand Down Expand Up @@ -48,4 +56,4 @@ requirements.check_files(["requirements.txt"])
packaging.version.Version('4.9.2'),
...
]}}
```
```

0 comments on commit f394435

Please sign in to comment.