Skip to content

lilydjwg/nvchecker

Repository files navigation

nvchecker (short for new version checker) is for checking if a new version of some software has been released.

This is the version 2.0 branch. For the old version 1.x, please switch to the v1.x branch.

Test Status PyPI version Documentation Status

Packaging status
  • Python 3.8+
  • Python library: structlog, platformdirs, tomli (on Python < 3.11)
  • One of these Python library combinations (ordered by preference):
    • tornado + pycurl
    • aiohttp
    • httpx with http2 support (experimental; only latest version is supported)
    • tornado
  • All commands used in your software version configuration files

To install:

pip3 install nvchecker

To use the latest code, you can also clone this repository and run:

pip install .

To see available options:

nvchecker --help

Run with one or more software version files:

nvchecker -c config_file

You normally will like to specify some "version record files"; see below.

For detailed documentation, see https://nvchecker.readthedocs.io/en/latest/.