### Install nvchecker from source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Install nvchecker by cloning the repository and running the setup script. This is useful for using the latest development code.

```bash
python3 setup.py install
```

--------------------------------

### TOML Configuration File Example

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

An example of a TOML configuration file for nvchecker, demonstrating how to specify software sources and other settings. This includes a `__config__` table for global options and individual software entries.

```toml
[keys]
# https://github.com/settings/tokens
# scope: repo -> public_repo
github = "ghp_<stripped>"
```

--------------------------------

### Example nvchecker configuration file

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

A basic TOML configuration file for nvchecker. It specifies the source for checking versions and provides details for GitHub and PyPI sources.

```toml
[nvchecker]
source = "github"
github = "lilydjwg/nvchecker"

[python-toml]
source = "pypi"
pypi = "toml"
```

--------------------------------

### Install nvchecker using pip

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Install the nvchecker package using pip3. This is the standard method for installing Python packages.

```bash
pip3 install nvchecker
```

--------------------------------

### Check ALPM Files Database

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Search for package files in a local ALPM files database without needing the package to be installed. This source runs the 'pacman -Flq ...' command and requires updating the database with 'pacman -Fy'.

```default
source = "alpmfiles"
```

--------------------------------

### Configure HTML Parser Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use the 'htmlparser' source to fetch version information by sending an HTTP request and parsing the body with XPath. An additional 'lxml' dependency is required. Install with 'pip install 'nvchecker[htmlparser]'.

```default
source = "htmlparser"
```

--------------------------------

### Parse RSS Feed with HTML Parser

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Example configuration for parsing an RSS feed using the 'htmlparser' source. It specifies the URL, XPath to extract item titles, and uses patterns to format the version.

```toml
[ProxmoxVE]
source = "htmlparser"
url = "https://my.proxmox.com/en/announcements/tag/proxmox-ve/rss"
xpath = "//item/title"
is_xml = true
from_pattern = 'Proxmox VE ([ 	
 !" released!'
to_pattern = '\1'
```

--------------------------------

### Display nvchecker help

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

View all available command-line options for nvchecker by running the --help command.

```bash
nvchecker --help
```

--------------------------------

### Check Go Packages and Modules

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Check for updates to Go packages and modules on pkg.go.dev.

```default
source = "go"
```

--------------------------------

### Configure PyPI Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration to check for updates on PyPI. Yanked releases are ignored. An additional dependency 'packaging' is required.

```default
source = "pypi"
```

--------------------------------

### Compare Version Records with nvcmp

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use the `nvcmp` command to compare new and old version record files and display differences. Specify the configuration file using the `-c` flag.

```default
$ nvcmp -c sample_source.toml
Sparkle Test App None -> 2.0
test 0.0 -> 0.1
```

--------------------------------

### Run nvchecker with configuration files

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Execute nvchecker with one or more configuration files specified using the -c flag. This is the primary way to use nvchecker for checking versions.

```bash
nvchecker -c config_file.toml
```

--------------------------------

### Configure BitBucket Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration to check for updates on BitBucket. The version is returned in date format unless use_max_tag is enabled.

```default
source = "bitbucket"
```

--------------------------------

### Configure Command Execution Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use the 'cmd' source to obtain the version by executing a shell command. The output is automatically stripped of leading/trailing whitespace.

```default
source = "cmd"
```

--------------------------------

### Check Snapcraft

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Check for the latest package versions in the Snapcraft store.

```default
source = "snapcraft"
```

--------------------------------

### Configure JSON Parser (jq) Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use the 'jq' source to fetch version information by sending an HTTP request and parsing the body with a jq filter. An additional 'jq' dependency is required.

```default
source = "jq"
```

--------------------------------

### Regex Source Configuration

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use the 'regex' source to search through a specific webpage for version strings. Specify the URL, and a regular expression to extract the version. Optional fields include encoding, post_data, and post_data_type.

```default
source = "regex"
```

--------------------------------

### Configure crates.io Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration to check for updates on crates.io. Yanked releases are ignored.

```default
source = "cratesio"
```

--------------------------------

### Check Opam Repository

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Check for the latest package versions in an arbitrary opam repository without using the opam command-line tool. Supports list options.

```default
source = "opam"
```

--------------------------------

### Configure ALPM Files Database Concurrency

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Configure the concurrency level for the 'alpmfiles' source. By default, it is set to 2. Be cautious as 'pacman -Flq ...' uses significant memory.

```toml
[__config__.source.alpmfiles]
concurrency = 2
```

--------------------------------

### Configure CPAN Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration to check for updates on CPAN.

```default
source = "cpan"
```

--------------------------------

### Configure Pacman Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration to check for updates in the local Pacman database on Arch Linux systems. Optionally strips the release part.

```default
source = "pacman"
```

--------------------------------

### Configure GitHub Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration to check for updates on GitHub. The default version format is a date, but this can be changed using specific options.

```default
source = "github"
```

--------------------------------

### Configure Git Repository Check with Dulwich

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

This configuration checks Git repositories using Dulwich, avoiding the 'git' executable. It does not currently support proxy environment variables. Requires the 'dulwich' dependency.

```yaml
source = "git_dulwich"
```

--------------------------------

### Track macOS Applications with Sparkle Framework

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use the 'sparkle' source to track updates for macOS applications using the Sparkle framework. Provide the URL of the Sparkle appcast and optionally specify the language for release notes.

```default
source = "sparkle"
```

--------------------------------

### Check Updates from Pagure

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Monitor updates from Pagure.io using the 'pagure' source. Specify the project name and optionally the host for alternative instances. This source returns tags.

```default
source = "pagure"
```

--------------------------------

### Check Open Vsx

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Check Open Vsx for extension updates using its unique identifier.

```default
source = "openvsx"
```

--------------------------------

### Manually Specify Version

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Manually specify the version string for an entry. This is useful when you want to approve each release before it is processed.

```default
source = "manual"
```

--------------------------------

### Configure GitLab Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration to check for updates on GitLab. The version is returned in date format unless use_max_tag is enabled. Supports self-hosted instances via the 'host' option and authentication via 'token'.

```default
source = "gitlab"
```

--------------------------------

### Configure RPM Repository Check

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration to check for the latest package versions in an RPM repository. Requires the 'lxml' dependency.

```yaml
source = "rpmrepo"
```

--------------------------------

### Configure Hackage Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration to check for updates on Hackage.

```default
source = "hackage"
```

--------------------------------

### Configure RubyGems Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration to check for updates on RubyGems.

```default
source = "gems"
```

--------------------------------

### Track Updates from Anitya

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use the 'anitya' source to track updates from Anitya (release-monitoring.org). You can specify the package in the format 'distro/package' or use the Anitya ID. The Anitya ID is preferred if both are provided.

```default
source = "anitya"
```

--------------------------------

### Configure Gitea Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration to check for updates on Gitea. The default version format is a date, but this can be changed using specific options.

```default
source = "gitea"
```

--------------------------------

### Configure CRAN Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration to check for updates on CRAN.

```default
source = "cran"
```

--------------------------------

### Track Ubuntu Linux Official Packages

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Utilize the 'ubuntupkg' source to track updates for Ubuntu Linux official packages. Specify the source package name and optionally the release suite.

```default
source = "ubuntupkg"
```

--------------------------------

### HTTP Header Source Configuration

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use the 'httpheader' source to fetch an HTTP request and search a specific header for version strings. The default header is 'Location'. Optional fields include regex, method, and follow_redirects.

```default
source = "httpheader"
```

--------------------------------

### Configure Packagist Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration to check for updates on Packagist.

```default
source = "packagist"
```

--------------------------------

### Simple Plugin Async Function Signature

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/plugin.md

Defines the required signature for a simple nvchecker source plugin. It takes name, configuration, cache, and key manager as arguments and returns a version result.

```python
async def get_version(
  name: str,
  conf: Entry,
  *,
  cache: AsyncCache,
  keymanager: KeyManager,
  **kwargs,
) -> VersionResult:
  ...
```

--------------------------------

### Check Visual Studio Code Marketplace

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Check the Visual Studio Code Marketplace for extension updates using its unique identifier.

```default
source = "vsmarketplace"
```

--------------------------------

### Check ALPM Database

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this snippet to check for package updates in a local ALPM database. An additional dependency 'pyalpm' is required.

```default
source = "alpm"
```

--------------------------------

### Configure AUR Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use the 'aur' source to check for updates in the Arch User Repository. This source may not work with per-item proxy settings due to batching.

```default
source = "aur"
```

--------------------------------

### Configure NPM Registry Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration to check for updates on the NPM Registry. Allows specifying a custom registry.

```default
source = "npm"
```

```default
[__config__.source.npm]
registry = "https://registry.npm.taobao.org"
```

--------------------------------

### Track Updates from Repology

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Monitor updates from Repology.org using the 'repology' source. You must provide the project name and the repository to check. An optional subrepository can also be specified.

```default
source = "repology"
```

--------------------------------

### Plugin Configuration Function

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/plugin.md

Defines the `configure` function used by nvchecker source plugins to receive custom configuration sections from the main configuration file.

```python
def configure(config):
  '''use the "config" dict in some way'''
  ...
```

--------------------------------

### Track Arbitrary APT Repository Packages

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Configure nvchecker to track updates from any APT repository using the 'apt' source. Specify the package name (binary or source), mirror URL, suite, repository, and architecture. The 'strip_release' option is also available.

```default
source = "apt"
```

--------------------------------

### Configure Maven Repository Source

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration to check for updates in a Maven repository. Defaults to Maven Central.

```default
source = "maven"
```

--------------------------------

### Configure Container Registry Check

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration to check for image tags on container registries like Docker. It supports checking the latest tag or by update time if a tag is not specified.

```yaml
source = "container"
```

--------------------------------

### Track Android SDK Packages

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Monitor updates for Android SDK packages using the 'android_sdk' source. Specify the package path prefix, repository type ('addon' or 'package'), and optionally the channel and host OS.

```default
source = "android_sdk"
```

--------------------------------

### Configure Git Repository Check with pygit2

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use this configuration for checking Git repositories without invoking the 'git' CLI, relying instead on pygit2/libgit2. Requires the 'pygit2' dependency.

```yaml
source = "git_pygit2"
```

--------------------------------

### Configure Mercurial Repository Check

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Configure nvchecker to check tags from an arbitrary Mercurial (hg) repository.

```yaml
source = "mercurial"
```

--------------------------------

### Configure Git Repository Check

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Configure nvchecker to monitor tags or branch commits in a Git repository. This method invokes the 'git' executable.

```yaml
source = "git"
```

--------------------------------

### Track Arch Linux Official Packages

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Use the 'archpkg' source to track updates for Arch Linux official packages. Specify the package name and optionally use 'strip_release' or 'provided' for version parsing.

```default
source = "archpkg"
```

--------------------------------

### Powerful Plugin Class Structure

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/plugin.md

Outlines the structure for a more powerful nvchecker source plugin using a class. It defines attributes for task processing and result queuing.

```python
class Worker(BaseWorker):
  async def run(self) -> None:
    ...
```

--------------------------------

### Plugin Class Attributes

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/plugin.md

Lists the attributes available within a powerful nvchecker source plugin class for managing tasks, results, and keys.

```python
token_q: Queue[bool],
result_q: Queue[RawResult],
tasks: List[Tuple[str, Entry]],
keymanager: KeyManager,
```

--------------------------------

### Combine Results from Other Entries

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Combine results from other Nvchecker entries using a specified format string. This is useful for creating dependent update checks.

```toml
[entry-1]
source = "cmd"
cmd = "echo 1"

[entry-2]
source = "cmd"
cmd = "echo 2"

[entry-3]
source = "combiner"
from = ["entry-1", "entry-2"]
format = "$1-$2"
```

--------------------------------

### Track Debian Linux Official Packages

Source: https://github.com/lilydjwg/nvchecker/blob/master/docs/usage.md

Configure nvchecker to monitor Debian Linux official packages using the 'debianpkg' source. You can specify the package name, Debian release suite, and whether to strip the release part.

```default
source = "debianpkg"
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.