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.1.0.tar.gz (5.9 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.1.0-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: requirementscheck-0.1.0.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for requirementscheck-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2fed0d1fe237c168e22df2762845984af538aa74d6ec79ceb2692d3910b073fa
MD5 e39bc897357484b336671206256b50e9
BLAKE2b-256 3d31a566b144d5dba0fda0a6d17d9b5a79ddbdee7f67f6e1b2df62f69e0667ff

See more details on using hashes here.

File details

Details for the file requirementscheck-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for requirementscheck-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0379b58464c48348531331d116e234867deba96da49995ee3bc87c8cc85626f3
MD5 cfe9f7f9a8e951575427bf98dff13c26
BLAKE2b-256 2940ff2ca9eb714a1c39df20198355dba57311780c0da72a66debcd2b2dabdcf

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