sleap.gui.release_checker

Module for checking for new releases on GitHub.

class sleap.gui.release_checker.ReleaseChecker(repo_id: str = 'murthylab/sleap', releases=NOTHING)[source]

Checker for new releases of SLEAP on GitHub.

This uses the GitHub REST API: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#releases

repo_id

The name of the repository (defaults to: “murthylab/sleap”)

releases

A list of `Release`s from querying GitHub.

checked

Indicates whether the releases page has been checked.

check_for_releases() → bool[source]

Check online for new releases.

Returns

True if new releases were found, or False if no new releases or was not able to connect to the web.

get_release(version: str) → sleap.gui.release_checker.Release[source]

Get a release by version tag string.

Parameters

version – Release version tag (e.g., “v1.0.9”)

Returns

The Release object with the associated version number.

property latest_prerelease

Return latest prerelease.

property latest_release

Return latest release.

property latest_stable

Return latest stable release.

sleap.gui.release_checker.filter_test_releases(releases: List[sleap.gui.release_checker.Release]) → List[sleap.gui.release_checker.Release][source]

Filter test releases out of a list of `Release`s.

Parameters

releases – A list of `Release`s.

Returns

The filtered list of Release`s. Any `Release that has a description containing the string “Do not use this release. This is a test.” will be excluded.