RepoMirrors
/
nvchecker
mirror of https://github.com/lilydjwg/nvchecker
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
New version checker for software releases
664 Commits 3 Branches 40 Tags 1.4 MiB
Python 100%
Go to file
Chih-Hsuan Yen f957acc756
Use my formal English name for previous contributions 		2020-10-06 22:17:47 +08:00
.github/workflows Create codeql-analysis.yml 2020-10-02 17:24:34 +08:00
docs Fix documentation for git source (fixes #159) 2020-10-06 10:01:25 +08:00
nvchecker fix versions sorting 2020-10-06 10:18:21 +08:00
nvchecker_source Use my formal English name for previous contributions 2020-10-06 22:17:47 +08:00
scripts add nvchecker-notify 2020-10-06 11:55:27 +08:00
tests Use my formal English name for previous contributions 2020-10-06 22:17:47 +08:00
.gitignore port tools.py and change record files to use json format 2020-08-26 20:06:13 +08:00
.travis.yml travis-ci: use keyfile when KEY is set 2020-09-01 21:51:47 +08:00
LICENSE add MIT LICENSE 2017-02-04 16:36:48 +08:00
README.rst releasing version 2.0 2020-10-01 14:41:35 +08:00
keyfile.toml.enc final tweak of keyfile 2020-08-20 15:18:43 +08:00
mypy.ini missing updates about the new "appdirs" dep 2020-08-31 17:50:11 +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 exclude docs/ in setup.py 2020-10-02 13:03:12 +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://travis-ci.org/lilydjwg/nvchecker.svg?branch=master
   :alt: Build Status
   :target: https://travis-ci.org/lilydjwg/nvchecker
.. 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/>`_.