status-symbol

A generic status check for pypi versioning

Installation

pip install status-symbol

Usage

The most basic usage is simply:

import status_symbol as ss

update_available, versions = ss.pypi_version_check('PACKAGE_NAME')
if update_available:
    ss.emit_update_warning('PACKAGE_NAME', versions)

Disabling update warnings

It is possible to disable update checks for packages like so:

ss.configuration.disable_version_check('PACKAGE_NAME')

One can check for disabled packages as well:

ss.configuration.is_disabled('PACKAGE_NAME')

So doing a check and enitting as warning looks like:

disabled = ss.configuration.is_disabled('PACKAGE_NAME')
if not disabled:
    update_available, versions = ss.pypi_version_check('PACKAGE_NAME')
    ss.emit_update_warning('PACKAGE_NAME', versions) if update_available else None

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

status_symbol-1.0.1.tar.gz (9.2 kB view details)

Uploaded Nov 6, 2024 Source

File details

Details for the file status_symbol-1.0.1.tar.gz.

File metadata

Download URL: status_symbol-1.0.1.tar.gz
Upload date: Nov 6, 2024
Size: 9.2 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for status_symbol-1.0.1.tar.gz
Algorithm	Hash digest
SHA256	`06681e05e116152ea60e01bc83cdf3981a9a884dc10987defc847792c7076b09`
MD5	`8681cfac4b6f13addd70085d31b38880`
BLAKE2b-256	`779fc0372a10e1e1663823c1989187031c16dc1774e8a130660a5df9b8e5f0c9`