nvchecker

mirror of https://github.com/lilydjwg/nvchecker synced 2024-12-18 21:05:00 +00:00

New version checker for software releases

Go to file

lilydjwg f8dd1a4212 docs: add an inline sample config also fix the code block display		2021-07-01 19:38:17 +08:00
.github/workflows	option to not verify HTTPS certificate	2021-06-23 16:08:47 +08:00
docs	docs: add an inline sample config	2021-07-01 19:38:17 +08:00
nvchecker	docs: add an inline sample config	2021-07-01 19:38:17 +08:00
nvchecker_source	apt: handle multiple verions correctly	2021-06-25 15:22:40 +08:00
scripts	nvchecker-notify: add the keyfile flag	2020-10-09 19:11:12 +08:00
tests	apt: handle multiple verions correctly	2021-06-25 15:22:40 +08:00
.gitignore	port tools.py and change record files to use json format	2020-08-26 20:06:13 +08:00
keyfile.toml.enc	final tweak of keyfile	2020-08-20 15:18:43 +08:00
LICENSE	add MIT LICENSE	2017-02-04 16:36:48 +08:00
mypy.ini	Add optional token for regex and httpheader. Add htmlparser source (#182 )	2021-06-11 16:18:39 +08:00
README.rst	update test status badget	2021-02-01 17:43:55 +08:00
sample_config.toml	rename sample_source.toml to sample_config.toml	2020-10-02 12:35:37 +08:00
setup.cfg	AsyncIO rewrite	2017-07-06 12:24:45 +08:00
setup.py	bump version to 2.4dev and fix docs/*.py being included in dist tarball	2021-03-19 13:51:48 +08:00

README.rst

**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.

.. image:: https://github.com/lilydjwg/nvchecker/workflows/run%20tests/badge.svg?branch=master
:alt: Test Status
:target: https://github.com/lilydjwg/nvchecker/actions?query=workflow%3A%22run+tests%22
.. image:: https://badge.fury.io/py/nvchecker.svg
:alt: PyPI version
:target: https://badge.fury.io/py/nvchecker
.. image:: https://readthedocs.org/projects/nvchecker/badge/?version=latest
:target: https://nvchecker.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://repology.org/badge/vertical-allrepos/nvchecker.svg
:alt: Packaging status
:target: https://repology.org/metapackage/nvchecker/versions

.. contents::
:local:

Dependency
----------
- Python 3.7+
- Python library: structlog, toml, appdirs
- 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

Install and Run
---------------
To install::

pip3 install nvchecker

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

python3 setup.py 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.

Documentation
-------------

For detailed documentation, see `https://nvchecker.readthedocs.io/en/latest/ <https://nvchecker.readthedocs.io/en/latest/>`_.