Metadata-Version: 2.4
Name: versionreporter
Version: 0.1
Summary: Report versions on main packages used in program.
Author: Tom Björkholm
Author-email: Tom Björkholm <klausuler_linnet0q@icloud.com>
License-Expression: MIT
Project-URL: Source code, https://bitbucket.org/tom-bjorkholm/version-reporter
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: pip>=26.0.1
Requires-Dist: setuptools>=82.0.1
Requires-Dist: build>=1.4.2
Requires-Dist: wheel>=0.46.3
Requires-Dist: pypi-simple>=1.8.0
Requires-Dist: packaging>=25.0
Requires-Dist: requests>=2.32.5
Requires-Dist: types-requests>=2.32.4.20250913
Dynamic: author
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python

# versionreporter

## What is it

The `versionreporter` package provides a very easy way to:

- report the currently used versions of the main packages used in an
  application, including the application package.

- report if there are newer versions available of any of the main packages
  for use on the currently running Python version.

- report if there are newer versions available of any of the main packages
  for use on a newer Python version than the one currently running.

- report when the developer of the main application package will no longer
  provide newer releases for the currently running Python version.

How this is used in an application is naturally up to the application designer.
One common way is to invoke `versionreporter` when a `--version` flag is
entered on the command line of the application.

## Installing versionreporter

### Installing versionreporter on mac and Linux

````sh
pip3 install --upgrade versionreporter
````

### Installing versionreporter on Microsoft Windows

````sh
pip install --upgrade versionreporter
````


## Example programs

The best way to learn to use this package is to use the provided
example programs:
[https://bitbucket.org/tom-bjorkholm/version-reporter/src/master/example/src/example/README.md](https://bitbucket.org/tom-bjorkholm/version-reporter/src/master/example/src/example/README.md).

## API documentation

You can find the public API documentation at [https://bitbucket.org/tom-bjorkholm/version-reporter/src/master/doc/api.md](https://bitbucket.org/tom-bjorkholm/version-reporter/src/master/doc/api.md)

You can find the protected API documentation at [https://bitbucket.org/tom-bjorkholm/version-reporter/src/master/doc/protected_api.md](https://bitbucket.org/tom-bjorkholm/version-reporter/src/master/doc/protected_api.md)

Even though the API documentation exists, most users and programmers probably
get a better start by reading the examples.

## Version history

| Version | Date        | Python version | Comment                     |
|---------|-------------|----------------|-----------------------------|
| 0.1     | 2026 Apr 08 | 3.12 or newer  | First released version      |

## Test summary

- Test result: 197 passed in 10s
- No flake8 warnings.
- No mypy errors found.
- Built version(s): 0.1
- Build and test using Python 3.14.3
