Skip to main content

A CLI utility to check and update Python package versions in requirements.txt files

Project description

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/. 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:

    python -m build
    python -m twine upload dist/*
    

Additional

Newest docs on GitHub: bbilly1/requirementscheck.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

requirementscheck-0.0.6.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

RequirementsCheck-0.0.6-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file requirementscheck-0.0.6.tar.gz.

File metadata

  • Download URL: requirementscheck-0.0.6.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.2

File hashes

Hashes for requirementscheck-0.0.6.tar.gz
Algorithm Hash digest
SHA256 4a05638110db5c5821c5868828eb5bb8195e86c89861111df138a82a6dc73f8a
MD5 8f47ae385634a7335e9ada18e3312ed2
BLAKE2b-256 db46a4ce9a82b656dca2565d0bc1d4d0b8eba09a10ca753e9ae3096ebb9d8b59

See more details on using hashes here.

File details

Details for the file RequirementsCheck-0.0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for RequirementsCheck-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5960801d216f6b886b6d79fda3dc390c6310c807d06804321842ae08e760b2a8
MD5 81a0ee0078c800b6585a4579b9450e37
BLAKE2b-256 a7f4a9cd688b702e06b63f2828faba5ff0bf1eba56414c01934a95d49c3bc145

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page