RepoMirrors/nvchecker
1
0
Fork 0
mirror of https://github.com/lilydjwg/nvchecker synced 2024-12-18 12:45:00 +00:00
Code Issues Packages Projects Releases Wiki Activity
New version checker for software releases
824 Commits 3 Branches 41 Tags 1.5 MiB
Python 100%
324f2f5f59
Go to file
lilydjwg 324f2f5f59 bump version to 2.10
2022-10-30 13:57:00 +08:00
.github/workflows fix mypy 2022-06-05 14:41:57 +08:00
docs Fix docs warnings 2022-10-29 14:20:07 +08:00
nvchecker bump version to 2.10 2022-10-30 13:57:00 +08:00
nvchecker_source gitea: omit default branch if not specified, fix for blm 2022-08-25 16:46:06 +08:00
scripts nvchecker-notify: try Notify 0.8 2022-07-16 15:48:59 +08:00
tests Update versions in test_{openvsx,vsmarketplace} 2022-10-29 14:22:23 +08:00
.gitignore port tools.py and change record files to use json format 2020-08-26 20:06:13 +08:00
.typos.toml fix typos 2022-04-21 17:16:34 +08:00
keyfile.toml.enc update keyfile.toml.enc 2021-07-27 16:06:39 +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 replace the toml library with tomli 2021-12-29 16:36:23 +08:00
sample_config.toml rename sample_source.toml to sample_config.toml 2020-10-02 12:35:37 +08:00
setup.cfg tests: fix some warnings 2022-04-07 14:06:03 +08:00
setup.py add support for using awesomeversion to compare versions 2022-06-05 14:31:54 +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, tomli, 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/>`_.