{"id":15654001,"url":"https://github.com/alexmojaki/outdated","last_synced_at":"2025-04-14T16:13:43.476Z","repository":{"id":53580218,"uuid":"128725967","full_name":"alexmojaki/outdated","owner":"alexmojaki","description":"Check if a version of a PyPI package is outdated","archived":false,"fork":false,"pushed_at":"2023-07-10T11:14:04.000Z","size":36,"stargazers_count":27,"open_issues_count":2,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-14T16:13:37.159Z","etag":null,"topics":["pypi","python","version","version-check","version-checker","versioncheck","versioning"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alexmojaki.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-09T06:37:56.000Z","updated_at":"2024-02-24T04:27:16.000Z","dependencies_parsed_at":"2024-06-18T20:10:53.721Z","dependency_job_id":null,"html_url":"https://github.com/alexmojaki/outdated","commit_stats":{"total_commits":47,"total_committers":4,"mean_commits":11.75,"dds":"0.14893617021276595","last_synced_commit":"26c8c28f135ee459f44f2cb956d5c54e7e95f3a5"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexmojaki%2Foutdated","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexmojaki%2Foutdated/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexmojaki%2Foutdated/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexmojaki%2Foutdated/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexmojaki","download_url":"https://codeload.github.com/alexmojaki/outdated/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248914115,"owners_count":21182359,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pypi","python","version","version-check","version-checker","versioncheck","versioning"],"created_at":"2024-10-03T12:48:48.551Z","updated_at":"2025-04-14T16:13:43.441Z","avatar_url":"https://github.com/alexmojaki.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# outdated\n\n[![Build Status](https://travis-ci.org/alexmojaki/outdated.svg?branch=master)](https://travis-ci.org/alexmojaki/outdated) [![Coverage Status](https://coveralls.io/repos/github/alexmojaki/outdated/badge.svg?branch=master\u0026uncache)](https://coveralls.io/github/alexmojaki/outdated?branch=master) [![Supports Python versions 2.7 and 3.5+](https://img.shields.io/pypi/pyversions/outdated.svg)](https://pypi.python.org/pypi/outdated)\n\nThis is a mini-library which, given a package name and a version, checks if it's the latest version available on PyPI.\n\nTo install:\n\n    pip install outdated\n\n## Quickstart:\n\n    from outdated import warn_if_outdated\n\n    warn_if_outdated('my-package-name', '1.2.3')\n\nThis will:\n\n- Show a warning if the given version is not the latest. The warning includes the package name, the given version, and the latest version.\n- Perform the check in a background thread (so it doesn't delay anything)\n- Make at most one HTTP call (unless there is an HTTP error, in which case it will try 3 times) to the PyPI server for that specific package\n- Cache the result of the HTTP call on disk for 24 hours\n- Show a warning if any exception occurs during the check\n\nThis will *not* check what version is currently installed, it will only use the given version. Library authors must make sure that the version in their `setup.py` matches the version here.\n\nThe package name argument must be exactly the name used on PyPI, so that e.g. https://pypi.python.org/pypi/my-package-name is a valid URL.\n\nOptional arguments:\n\n- `background` (default `True`): run the check in a separate thread. Set to `False` to run immediately.\n- `raise_exceptions` (default: `False`): if `True`, allow exceptions to bubble to the top. Otherwise, show a warning including the exception message. If `background` is `True` and this is `True` then this will result in a full traceback showing but the process continuing.\n\n## Lower level API\n\n    from outdated import check_outdated\n\n    is_outdated, latest_version = check_outdated('my-package-name', '1.2.3')\n    \n`is_outdated` is a boolean which is True if the given version is earlier than the latest version, which is the string `latest_version`.\n\nOptional arguments:\n\n- `repository_url` (default `https://pypi.python.org/pypi/%s/json`): a `%` style format string to use a different repository PyPI repository URL, e.g. test.pypi.org or a private repository. The string is formatted with the package name.\n\nThis still makes the HTTP call with retries and caches the result on disk. It doesn't use a separate thread or emit any warnings (unless there is an exception specifically while using the cache, in which case the check will be done without the cache).\n\n## Additional configuration\n\nTo disable all warnings from this library, set the environment variable `OUTDATED_IGNORE` to any non-empty value.\n\nTo always raise exceptions instead of converting them to warnings (both in general in `warn_if_outdated` and more specifically when there's a caching problem) set the environment variable `OUTDATED_RAISE_EXCEPTION=1`.\n\nThe warnings are also categorised so that you can easily control them with standard [warning filters](https://docs.python.org/3/library/warnings.html#the-warnings-filter). The classes are [here](https://github.com/alexmojaki/outdated/blob/master/outdated/mywarnings.py) and can be imported directly from the `outdated` module.\n\n## Performance\n\nThis library works by fetching a URL such as [this](https://pypi.python.org/pypi/requests/json) - the time it takes to visit that link is essentially the speed of the library. This is much faster than the command `pip list --outdated` or any equivalent code.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexmojaki%2Foutdated","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexmojaki%2Foutdated","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexmojaki%2Foutdated/lists"}