tool_shed.managers package¶
Submodules¶
tool_shed.managers.groups module¶
Manager and Serializer for TS groups.
- class tool_shed.managers.groups.GroupManager(*args, **kwargs)[source]¶
Bases:
object
Interface/service object for interacting with TS groups.
tool_shed.managers.repositories module¶
Manager and Serializer for TS repositories.
- tool_shed.managers.repositories.search(trans: ProvidesUserContext, q: str, page: int = 1, page_size: int = 10)[source]¶
Perform the search over TS repositories. Note that search works over the Whoosh index which you have to pre-create with scripts/tool_shed/build_ts_whoosh_index.sh manually. Also TS config option toolshed_search_on has to be True and whoosh_index_dir has to be specified.
- class tool_shed.managers.repositories.UpdatesRequest(*, name: Optional[str] = None, owner: Optional[str] = None, changeset_revision: str, hexlify: bool = True)[source]¶
Bases:
BaseModel
- tool_shed.managers.repositories.check_updates(app: ToolShedApp, request: UpdatesRequest) Union[str, Dict[str, Any]] [source]¶
- tool_shed.managers.repositories.guid_to_repository(app: ToolShedApp, tool_id: str) Repository [source]¶
- tool_shed.managers.repositories.index_tool_ids(app: ToolShedApp, tool_ids: List[str]) Dict[str, Any] [source]¶
- tool_shed.managers.repositories.index_repositories(app: ToolShedApp, name: Optional[str], owner: Optional[str], deleted: bool)[source]¶
- tool_shed.managers.repositories.can_manage_repo(trans: ProvidesUserContext, repository: Repository) bool [source]¶
- tool_shed.managers.repositories.can_update_repo(trans: ProvidesUserContext, repository: Repository) bool [source]¶
- tool_shed.managers.repositories.get_repository_metadata_for_management(trans: ProvidesUserContext, encoded_repository_id: str, changeset_revision: str) RepositoryMetadata [source]¶
- tool_shed.managers.repositories.get_install_info(trans: ProvidesRepositoriesContext, name, owner, changeset_revision) Tuple[Optional[Dict], Union[RepositoryMetadataInstallInfoDict, EmptyDict], Union[Dict[str, List], EmptyDict]] [source]¶
- tool_shed.managers.repositories.get_ordered_installable_revisions(app: ToolShedApp, name: Optional[str], owner: Optional[str], tsr_id: Optional[str]) List[str] [source]¶
- tool_shed.managers.repositories.get_repository_metadata_dict(app: ToolShedApp, id: str, recursive: bool, downloadable_only: bool) Dict[str, Any] [source]¶
- tool_shed.managers.repositories.readmes(app: ToolShedApp, repository: Repository, changeset_revision: str) dict [source]¶
- tool_shed.managers.repositories.reset_metadata_on_repository(trans: ProvidesUserContext, repository_id) ResetMetadataOnRepositoryResponse [source]¶
- tool_shed.managers.repositories.create_repository(trans: ProvidesUserContext, request: CreateRepositoryRequest) Repository [source]¶
- tool_shed.managers.repositories.to_element_dict(app, repository: Repository, include_categories: bool = False) Dict[str, Any] [source]¶
- tool_shed.managers.repositories.repositories_by_category(app: ToolShedApp, category_id: str, page: Optional[int] = None, sort_key: str = 'name', sort_order: str = 'asc', installable: bool = True)[source]¶
- tool_shed.managers.repositories.to_model(app, repository: Repository) Repository [source]¶
- tool_shed.managers.repositories.to_detailed_model(app, repository: Repository) DetailedRepository [source]¶