RepoMirrors/nvchecker
1
0
Fork 0
mirror of https://github.com/lilydjwg/nvchecker synced 2025-02-14 17:37:32 +00:00
Code Issues Packages Projects Releases Wiki Activity
New version checker for software releases
1,016 Commits 3 Branches 41 Tags 1.6 MiB
Python 99.5%
Shell 0.5%
bd72ea04d2
Go to file
lilydjwg bd72ea04d2 Merge branch 'test-ci'
2025-02-10 17:38:52 +08:00
.github/workflows tests: venv mitmproxy to avoid conflict 2025-02-10 17:31:01 +08:00
docs Explicitly document the behavior around yanked releases 2025-02-09 14:58:31 -05:00
nvchecker tests: use source distribution of pycurl so that it supports more compression types 2025-02-10 16:18:09 +08:00
nvchecker_source archpkg: update url 2025-02-10 15:51:05 +08:00
scripts run_cached_tests: output mitmdump logs 2025-02-10 17:31:01 +08:00
tests tests: I don't know why but these tests are flaky 2025-02-10 17:31:01 +08:00
.gitignore introduce tox support 2022-03-03 09:56:33 -08:00
.readthedocs.yaml fix readthedocs 2023-08-26 11:47:34 +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 make mypy happy 2024-12-02 23:56:11 +08:00
pyproject.toml tests: use asyncio_default_fixture_loop_scope = "session" 2024-11-03 18:30:54 +08:00
README.rst drop support for Python 3.7 2023-12-09 20:38:23 +08:00
sample_config.toml remove obsolete entries from sample_config.toml 2025-02-09 15:19:14 +08:00
setup.cfg Use walrus operator and explicitly require python >= 3.8 2025-02-09 14:50:10 -05:00
tox.ini drop support for Python 3.7 2023-12-09 20:38:23 +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.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

Install and Run
---------------
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.

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

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