Packages¶
- skare3_tools.packages.get_package_list(update=False)[source]¶
Return a list of dictionaries, one per package.
Read from the data store, which needs neither a Github token nor a conda query.
update=Trueassembles the list from the skare3 recipes and the organizations instead.- Parameters:
update – bool Assemble the list from Github instead of reading the store.
- Returns:
list of dict Each dictionary contains only basic information.
- skare3_tools.packages.get_repository_info(owner_repo, update=False, **kwargs)[source]¶
Get information about a Github repository.
By default this reads the data store, which needs no Github token (see
DataClient). The store holds one rendering of each repository, so any argument asking for something else – a differentsince, for instance – queries Github instead, as doesupdate=True.- Parameters:
owner_repo – str the name of the repository, including owner, something like ‘sot/skare3’.
update – bool Query Github directly instead of reading the store.
since – int or str the maximum number of releases to look back, or the release tag to look back to (not inclusive).
include_unreleased_commits – bool whether to include commits and merges for repositories that have no release. This affects only top-level entries ‘commits’, ‘merges’, ‘merge_info’. It is for backward compatibility with the dashboard.
include_commits – bool whether to include commits in release_info.
- Returns:
dict
- skare3_tools.packages.get_repositories_info(repositories=None, update=False)[source]¶
Get information about many Github repositories.
By default this reads the data store (see
DataClient);update=Truequeries Github directly instead, which needs a token and is much slower.- Parameters:
repositories – list of str Repositories (“owner/name”) to report on. Default: all of them. Repositories the store does not know about are reported and skipped.
update – bool Query Github directly instead of reading the store.
- Returns:
dict
- skare3_tools.packages.get_conda_pkg_info(conda_package, conda_channel=None)[source]¶
Get information on a conda package.
- Parameters:
conda_package – str Name of conda package
conda_channel – str url of the channel
- Returns:
dict
- skare3_tools.packages.get_conda_pkg_dependencies(conda_package, conda_channel=None)[source]¶
Get dependencies of a conda package.
- Parameters:
conda_package – str Name of conda package
conda_channel – str url of the channel
- Returns:
dict
- skare3_tools.packages.record_options()[source]¶
The arguments the records in the data store are produced with.
skare3-refreshrecords these in the aggregate, andget_repository_infocompares its arguments against the recorded ones to decide whether the store can answer.- Returns:
dict