https://github.com/bbilly1/requirementscheck
Python CLI to check your requirements.txt files for updates
https://github.com/bbilly1/requirementscheck
package-management python requirements
Last synced: about 1 year ago
JSON representation
Python CLI to check your requirements.txt files for updates
- Host: GitHub
- URL: https://github.com/bbilly1/requirementscheck
- Owner: bbilly1
- License: mit
- Created: 2024-11-04T04:21:41.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-25T03:35:04.000Z (over 1 year ago)
- Last Synced: 2025-04-05T23:06:46.351Z (about 1 year ago)
- Topics: package-management, python, requirements
- Language: Python
- Homepage:
- Size: 36.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Version Check
Core Functionality:
- Look for requirements*.txt files in your working directory and check for updates.
- Prompt to confirm each update with an upstream url.
## Install
RequirementsCheck is available on [pypi.org/project/RequirementsCheck/](https://pypi.org/project/RequirementsCheck/). Install into your environment with pip:
```
pip install requirementscheck
```
Add it to your `requirements.txt` file, pin the release, and use requirementscheck to update requirementscheck in your `requirements.txt` file.
## Run
From your Python project root folder run:
```
requirementscheck
```
to look for requirements files and update your dependencies based on your prompts.
Additionally, this takes to optional arguments:
- `--confirm | --no-confirm`: Ask for confirmation with link to upstream package before applying update, default `True`.
- `--pin | --no-pin`: Pin a dependency to the latest version if found to be not pinned, default `False`.
- `-h | --help`: Print help text and exit.
## Ignore
You can ignore certain lines in your requirements file by appending a comment `# rc:ignore` to the line, indicating for requirementscheck to ignore that line.
## Build
Run tests:
```
python -m unittest src/requirementscheck/test_requirementscheck.py
```
1. Update the version in setup.py
2. Git Tag
3. Push tag
4. Create release on GH
5. Build and update package to pypi:
```bash
python -m build
python -m twine upload dist/*
```
## Additional
Newest docs on GitHub: [bbilly1/requirementscheck](https://github.com/bbilly1/requirementscheck).