-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #99 from inab/docs_module
Docs module, with hooks usable from Sphinx
- Loading branch information
Showing
2 changed files
with
126 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
#!/usr/bin/env python | ||
# -*- coding: utf-8 -*- | ||
|
||
# SPDX-License-Identifier: Apache-2.0 | ||
# Copyright 2020-2024 Barcelona Supercomputing Center (BSC), Spain | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
from .wfexs_backend import WfExSBackend | ||
from typing import TYPE_CHECKING | ||
|
||
from .utils.licences import LicenceMatcherSingleton | ||
|
||
if TYPE_CHECKING: | ||
from typing import ( | ||
Sequence, | ||
Tuple, | ||
) | ||
|
||
from .common import ( | ||
ContainerType, | ||
LicenceDescription, | ||
) | ||
|
||
from .workflow_engines import ( | ||
WorkflowType, | ||
) | ||
|
||
|
||
def list_containers() -> "Sequence[ContainerType]": | ||
wfBackend = WfExSBackend() | ||
return wfBackend.listImplementedContainerTypes() | ||
|
||
|
||
def list_export_plugins() -> "Sequence[str]": | ||
wfBackend = WfExSBackend() | ||
return wfBackend.listExportPluginNames() | ||
|
||
|
||
def list_fetchers() -> "Sequence[Tuple[str, str, int]]": | ||
wfBackend = WfExSBackend() | ||
return wfBackend.describeFetchableSchemes() | ||
|
||
|
||
def list_licences() -> "Sequence[LicenceDescription]": | ||
licence_matcher = LicenceMatcherSingleton() | ||
return licence_matcher.describeDocumentedLicences() | ||
|
||
|
||
def list_workflow_engines() -> "Sequence[WorkflowType]": | ||
wfBackend = WfExSBackend() | ||
return wfBackend.WORKFLOW_ENGINES |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters