ogdc-runner 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ogdc_runner-0.1.0/.git_archival.txt +4 -0
- ogdc_runner-0.1.0/.gitattributes +1 -0
- ogdc_runner-0.1.0/.github/dependabot.yml +11 -0
- ogdc_runner-0.1.0/.github/workflows/publish.yml +132 -0
- ogdc_runner-0.1.0/.github/workflows/test.yml +66 -0
- ogdc_runner-0.1.0/.gitignore +158 -0
- ogdc_runner-0.1.0/.pre-commit-config.yaml +71 -0
- ogdc_runner-0.1.0/.readthedocs.yaml +22 -0
- ogdc_runner-0.1.0/CHANGELOG.md +5 -0
- ogdc_runner-0.1.0/Dockerfile +7 -0
- ogdc_runner-0.1.0/LICENSE +19 -0
- ogdc_runner-0.1.0/PKG-INFO +102 -0
- ogdc_runner-0.1.0/README.md +32 -0
- ogdc_runner-0.1.0/docs/.gitignore +1 -0
- ogdc_runner-0.1.0/docs/CONTRIBUTING.md +193 -0
- ogdc_runner-0.1.0/docs/Makefile +20 -0
- ogdc_runner-0.1.0/docs/architecture.md +47 -0
- ogdc_runner-0.1.0/docs/conf.py +102 -0
- ogdc_runner-0.1.0/docs/index.md +20 -0
- ogdc_runner-0.1.0/docs/make.bat +35 -0
- ogdc_runner-0.1.0/docs/recipes.md +116 -0
- ogdc_runner-0.1.0/docs/user_guide.md +58 -0
- ogdc_runner-0.1.0/noxfile.py +89 -0
- ogdc_runner-0.1.0/pyproject.toml +178 -0
- ogdc_runner-0.1.0/src/ogdc_runner/__init__.py +11 -0
- ogdc_runner-0.1.0/src/ogdc_runner/__main__.py +74 -0
- ogdc_runner-0.1.0/src/ogdc_runner/_version.py +34 -0
- ogdc_runner-0.1.0/src/ogdc_runner/_version.pyi +4 -0
- ogdc_runner-0.1.0/src/ogdc_runner/api.py +51 -0
- ogdc_runner-0.1.0/src/ogdc_runner/argo.py +199 -0
- ogdc_runner-0.1.0/src/ogdc_runner/constants.py +11 -0
- ogdc_runner-0.1.0/src/ogdc_runner/exceptions.py +25 -0
- ogdc_runner-0.1.0/src/ogdc_runner/inputs.py +61 -0
- ogdc_runner-0.1.0/src/ogdc_runner/models/__init__.py +0 -0
- ogdc_runner-0.1.0/src/ogdc_runner/models/recipe_config.py +85 -0
- ogdc_runner-0.1.0/src/ogdc_runner/publish.py +168 -0
- ogdc_runner-0.1.0/src/ogdc_runner/py.typed +0 -0
- ogdc_runner-0.1.0/src/ogdc_runner/recipe/__init__.py +24 -0
- ogdc_runner-0.1.0/src/ogdc_runner/recipe/shell.py +119 -0
- ogdc_runner-0.1.0/src/ogdc_runner/recipe/viz_workflow.py +286 -0
- ogdc_runner-0.1.0/tests/conftest.py +12 -0
- ogdc_runner-0.1.0/tests/integration/test_ogdc_recipe.py +45 -0
- ogdc_runner-0.1.0/tests/test_recipe_dir/meta.yml +6 -0
- ogdc_runner-0.1.0/tests/test_recipe_dir/recipe.sh +2 -0
- ogdc_runner-0.1.0/tests/unit/test_argo.py +122 -0
- ogdc_runner-0.1.0/tests/unit/test_models.py +52 -0
- ogdc_runner-0.1.0/tests/unit/test_package.py +9 -0
- ogdc_runner-0.1.0/tests/unit/test_shell.py +12 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
.git_archival.txt export-subst
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
name: "Build and optionally release PyPi and docker packages"
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch:
|
|
5
|
+
pull_request:
|
|
6
|
+
push:
|
|
7
|
+
branches:
|
|
8
|
+
- "main"
|
|
9
|
+
tags:
|
|
10
|
+
- "v[0-9]+.[0-9]+.[0-9]+*"
|
|
11
|
+
|
|
12
|
+
concurrency:
|
|
13
|
+
group: "${{ github.workflow }}-${{ github.ref }}"
|
|
14
|
+
cancel-in-progress: true
|
|
15
|
+
|
|
16
|
+
env:
|
|
17
|
+
# Many color libraries just need this to be set to any value, but at least
|
|
18
|
+
# one distinguishes color depth, where "3" -> "256-bit color".
|
|
19
|
+
FORCE_COLOR: 3
|
|
20
|
+
DOCKER_IMAGE_NAME: "ogdc-runner"
|
|
21
|
+
# GitHub Actions expressions don't have great conditional support, so
|
|
22
|
+
# writing a ternary expression looks a lot like bash. In Python, this
|
|
23
|
+
# would read as:
|
|
24
|
+
# github.ref_name if github.ref_type == 'tag' else 'latest'
|
|
25
|
+
# https://docs.github.com/en/actions/learn-github-actions/expressions
|
|
26
|
+
DOCKER_IMAGE_TAG:
|
|
27
|
+
"${{ github.ref_type == 'tag' && github.ref_name || 'latest' }}"
|
|
28
|
+
|
|
29
|
+
jobs:
|
|
30
|
+
#######################################################################
|
|
31
|
+
# Build Python
|
|
32
|
+
#######################################################################
|
|
33
|
+
build-python:
|
|
34
|
+
name: "Build python distributions (wheel & sdist)"
|
|
35
|
+
runs-on: "ubuntu-latest"
|
|
36
|
+
|
|
37
|
+
steps:
|
|
38
|
+
- uses: "actions/checkout@v5"
|
|
39
|
+
with:
|
|
40
|
+
fetch-depth: 0
|
|
41
|
+
|
|
42
|
+
- uses: "hynek/build-and-inspect-python-package@v2"
|
|
43
|
+
|
|
44
|
+
#######################################################################
|
|
45
|
+
# Build Docker
|
|
46
|
+
#######################################################################
|
|
47
|
+
build-docker:
|
|
48
|
+
name: "Build docker container image"
|
|
49
|
+
runs-on: "ubuntu-latest"
|
|
50
|
+
steps:
|
|
51
|
+
- name: "Check out repository"
|
|
52
|
+
uses: "actions/checkout@v5"
|
|
53
|
+
|
|
54
|
+
- name: "Build container image"
|
|
55
|
+
run: |
|
|
56
|
+
docker build --tag "ghcr.io/qgreenland-net/${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG}" .
|
|
57
|
+
docker save "ghcr.io/qgreenland-net/${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG}" -o docker-image.tar
|
|
58
|
+
- name: "Upload image tarball as artifact"
|
|
59
|
+
uses: "actions/upload-artifact@v4"
|
|
60
|
+
with:
|
|
61
|
+
name: "docker-image-tar"
|
|
62
|
+
path: "docker-image.tar"
|
|
63
|
+
|
|
64
|
+
#######################################################################
|
|
65
|
+
# Publish python
|
|
66
|
+
#######################################################################
|
|
67
|
+
publish-python:
|
|
68
|
+
if: github.ref_type == 'tag'
|
|
69
|
+
# Only publish if both Python and Docker builds are successful.
|
|
70
|
+
needs: ["build-python", "build-docker"]
|
|
71
|
+
name: "Publish to PyPI"
|
|
72
|
+
environment: "pypi"
|
|
73
|
+
permissions:
|
|
74
|
+
id-token: "write"
|
|
75
|
+
runs-on: "ubuntu-latest"
|
|
76
|
+
|
|
77
|
+
steps:
|
|
78
|
+
- uses: "actions/download-artifact@v5"
|
|
79
|
+
with:
|
|
80
|
+
name: "Packages"
|
|
81
|
+
path: "dist"
|
|
82
|
+
|
|
83
|
+
- uses: "pypa/gh-action-pypi-publish@release/v1"
|
|
84
|
+
|
|
85
|
+
#######################################################################
|
|
86
|
+
# Publish Docker
|
|
87
|
+
#######################################################################
|
|
88
|
+
publish-docker:
|
|
89
|
+
# Only push on tag or push to main.
|
|
90
|
+
if: github.ref_type == 'tag' || github.ref == 'refs/heads/main'
|
|
91
|
+
name: "Push docker container image"
|
|
92
|
+
runs-on: "ubuntu-latest"
|
|
93
|
+
# Only publish if both Python and Docker builds are successful.
|
|
94
|
+
needs: ["build-python", "build-docker"]
|
|
95
|
+
steps:
|
|
96
|
+
- name: "Download image tarball"
|
|
97
|
+
uses: "actions/download-artifact@v4"
|
|
98
|
+
with:
|
|
99
|
+
name: "docker-image-tar"
|
|
100
|
+
|
|
101
|
+
- name: "Load Docker image"
|
|
102
|
+
run: "docker load -i docker-image.tar"
|
|
103
|
+
|
|
104
|
+
- name: "GHCR login"
|
|
105
|
+
uses: "docker/login-action@v3"
|
|
106
|
+
with:
|
|
107
|
+
registry: "ghcr.io"
|
|
108
|
+
username: "${{ github.repository_owner }}"
|
|
109
|
+
password: "${{ secrets.GITHUB_TOKEN }}"
|
|
110
|
+
|
|
111
|
+
- name: "Push to image registry (GHCR)"
|
|
112
|
+
run: |
|
|
113
|
+
# Push to GHCR
|
|
114
|
+
docker push "ghcr.io/qgreenland-net/${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG}"
|
|
115
|
+
|
|
116
|
+
#######################################################################
|
|
117
|
+
# GitHub release
|
|
118
|
+
#######################################################################
|
|
119
|
+
publish-gh-release:
|
|
120
|
+
# Only publish a GH release when publish-python and publish-docker tasks are
|
|
121
|
+
# complete and the ref type is a tag (e.g,. v0.1.0).
|
|
122
|
+
if: github.ref_type == 'tag'
|
|
123
|
+
name: "Create GitHub release"
|
|
124
|
+
needs: ["publish-python", "publish-docker"]
|
|
125
|
+
runs-on: "ubuntu-latest"
|
|
126
|
+
steps:
|
|
127
|
+
- name: "Checkout"
|
|
128
|
+
uses: "actions/checkout@v5"
|
|
129
|
+
- name: "Release"
|
|
130
|
+
uses: "softprops/action-gh-release@v2"
|
|
131
|
+
with:
|
|
132
|
+
generate_release_notes: true
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
name: "Quality checks"
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch:
|
|
5
|
+
pull_request:
|
|
6
|
+
push:
|
|
7
|
+
branches:
|
|
8
|
+
- "main"
|
|
9
|
+
|
|
10
|
+
concurrency:
|
|
11
|
+
group: "${{ github.workflow }}-${{ github.ref }}"
|
|
12
|
+
cancel-in-progress: true
|
|
13
|
+
|
|
14
|
+
env:
|
|
15
|
+
# Many color libraries just need this to be set to any value, but at least
|
|
16
|
+
# one distinguishes color depth, where "3" -> "256-bit color".
|
|
17
|
+
FORCE_COLOR: 3
|
|
18
|
+
|
|
19
|
+
jobs:
|
|
20
|
+
typecheck:
|
|
21
|
+
name: "Typecheck"
|
|
22
|
+
runs-on: "ubuntu-latest"
|
|
23
|
+
steps:
|
|
24
|
+
- uses: "actions/checkout@v5"
|
|
25
|
+
with:
|
|
26
|
+
fetch-depth: 0
|
|
27
|
+
- uses: "actions/setup-python@v6"
|
|
28
|
+
with:
|
|
29
|
+
python-version: "3.11"
|
|
30
|
+
|
|
31
|
+
- name: "Install package"
|
|
32
|
+
run: "python -m pip install .[test]"
|
|
33
|
+
|
|
34
|
+
- name: "Typecheck package"
|
|
35
|
+
run: "mypy"
|
|
36
|
+
|
|
37
|
+
test:
|
|
38
|
+
name: "Check Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}"
|
|
39
|
+
runs-on: "${{ matrix.runs-on }}"
|
|
40
|
+
strategy:
|
|
41
|
+
fail-fast: false
|
|
42
|
+
matrix:
|
|
43
|
+
python-version: ["3.11", "3.12"]
|
|
44
|
+
runs-on: ["ubuntu-latest", "macos-latest", "windows-latest"]
|
|
45
|
+
|
|
46
|
+
steps:
|
|
47
|
+
- uses: "actions/checkout@v5"
|
|
48
|
+
with:
|
|
49
|
+
fetch-depth: 0
|
|
50
|
+
|
|
51
|
+
- uses: "actions/setup-python@v6"
|
|
52
|
+
with:
|
|
53
|
+
python-version: "${{ matrix.python-version }}"
|
|
54
|
+
allow-prereleases: true
|
|
55
|
+
|
|
56
|
+
- name: "Install package"
|
|
57
|
+
run: "python -m pip install .[test]"
|
|
58
|
+
|
|
59
|
+
- name: "Test package"
|
|
60
|
+
# prettier-ignore
|
|
61
|
+
run: "python -m pytest -ra --durations=20 --cov --cov-report=xml --cov-report=term tests/unit"
|
|
62
|
+
|
|
63
|
+
- name: "Upload coverage report"
|
|
64
|
+
uses: "codecov/codecov-action@v5.5.1"
|
|
65
|
+
with:
|
|
66
|
+
token: "${{ secrets.CODECOV_TOKEN }}"
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py,cover
|
|
50
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
|
|
74
|
+
# PyBuilder
|
|
75
|
+
.pybuilder/
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
+
# .python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
#Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
|
|
98
|
+
__pypackages__/
|
|
99
|
+
|
|
100
|
+
# Celery stuff
|
|
101
|
+
celerybeat-schedule
|
|
102
|
+
celerybeat.pid
|
|
103
|
+
|
|
104
|
+
# SageMath parsed files
|
|
105
|
+
*.sage.py
|
|
106
|
+
|
|
107
|
+
# Environments
|
|
108
|
+
.env
|
|
109
|
+
.venv
|
|
110
|
+
env/
|
|
111
|
+
venv/
|
|
112
|
+
ENV/
|
|
113
|
+
env.bak/
|
|
114
|
+
venv.bak/
|
|
115
|
+
|
|
116
|
+
# Spyder project settings
|
|
117
|
+
.spyderproject
|
|
118
|
+
.spyproject
|
|
119
|
+
|
|
120
|
+
# Rope project settings
|
|
121
|
+
.ropeproject
|
|
122
|
+
|
|
123
|
+
# mkdocs documentation
|
|
124
|
+
/site
|
|
125
|
+
|
|
126
|
+
# mypy
|
|
127
|
+
.mypy_cache/
|
|
128
|
+
.dmypy.json
|
|
129
|
+
dmypy.json
|
|
130
|
+
|
|
131
|
+
# Pyre type checker
|
|
132
|
+
.pyre/
|
|
133
|
+
|
|
134
|
+
# pytype static type analyzer
|
|
135
|
+
.pytype/
|
|
136
|
+
|
|
137
|
+
# Cython debug symbols
|
|
138
|
+
cython_debug/
|
|
139
|
+
|
|
140
|
+
# setuptools_scm
|
|
141
|
+
src/*/_version.py
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
# ruff
|
|
145
|
+
.ruff_cache/
|
|
146
|
+
|
|
147
|
+
# OS specific stuff
|
|
148
|
+
.DS_Store
|
|
149
|
+
.DS_Store?
|
|
150
|
+
._*
|
|
151
|
+
.Spotlight-V100
|
|
152
|
+
.Trashes
|
|
153
|
+
ehthumbs.db
|
|
154
|
+
Thumbs.db
|
|
155
|
+
|
|
156
|
+
# Common editor files
|
|
157
|
+
*~
|
|
158
|
+
*.swp
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
ci:
|
|
2
|
+
autoupdate_commit_msg: "chore: update pre-commit hooks"
|
|
3
|
+
autofix_commit_msg: "style: pre-commit fixes"
|
|
4
|
+
autoupdate_schedule: "monthly"
|
|
5
|
+
|
|
6
|
+
repos:
|
|
7
|
+
- repo: https://github.com/adamchainz/blacken-docs
|
|
8
|
+
rev: "1.20.0"
|
|
9
|
+
hooks:
|
|
10
|
+
- id: blacken-docs
|
|
11
|
+
additional_dependencies: [black==24.*]
|
|
12
|
+
|
|
13
|
+
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
14
|
+
rev: "v6.0.0"
|
|
15
|
+
hooks:
|
|
16
|
+
- id: check-added-large-files
|
|
17
|
+
- id: check-case-conflict
|
|
18
|
+
- id: check-merge-conflict
|
|
19
|
+
- id: check-symlinks
|
|
20
|
+
- id: check-yaml
|
|
21
|
+
- id: debug-statements
|
|
22
|
+
- id: end-of-file-fixer
|
|
23
|
+
- id: mixed-line-ending
|
|
24
|
+
- id: name-tests-test
|
|
25
|
+
args: ["--pytest-test-first"]
|
|
26
|
+
- id: requirements-txt-fixer
|
|
27
|
+
- id: trailing-whitespace
|
|
28
|
+
|
|
29
|
+
- repo: https://github.com/pre-commit/pygrep-hooks
|
|
30
|
+
rev: "v1.10.0"
|
|
31
|
+
hooks:
|
|
32
|
+
- id: rst-backticks
|
|
33
|
+
- id: rst-directive-colons
|
|
34
|
+
- id: rst-inline-touching-normal
|
|
35
|
+
|
|
36
|
+
- repo: https://github.com/rbubley/mirrors-prettier
|
|
37
|
+
rev: "v3.6.2"
|
|
38
|
+
hooks:
|
|
39
|
+
- id: prettier
|
|
40
|
+
types_or: [yaml, markdown, html, css, scss, javascript, json]
|
|
41
|
+
args: [--prose-wrap=always]
|
|
42
|
+
|
|
43
|
+
- repo: https://github.com/astral-sh/ruff-pre-commit
|
|
44
|
+
rev: "v0.13.3"
|
|
45
|
+
hooks:
|
|
46
|
+
- id: ruff
|
|
47
|
+
args: ["--fix", "--show-fixes"]
|
|
48
|
+
- id: ruff-format
|
|
49
|
+
|
|
50
|
+
- repo: https://github.com/codespell-project/codespell
|
|
51
|
+
rev: "v2.4.1"
|
|
52
|
+
hooks:
|
|
53
|
+
- id: codespell
|
|
54
|
+
|
|
55
|
+
- repo: https://github.com/shellcheck-py/shellcheck-py
|
|
56
|
+
rev: "v0.11.0.1"
|
|
57
|
+
hooks:
|
|
58
|
+
- id: shellcheck
|
|
59
|
+
|
|
60
|
+
- repo: https://github.com/abravalheri/validate-pyproject
|
|
61
|
+
rev: "v0.24.1"
|
|
62
|
+
hooks:
|
|
63
|
+
- id: validate-pyproject
|
|
64
|
+
additional_dependencies: ["validate-pyproject-schema-store[all]"]
|
|
65
|
+
|
|
66
|
+
- repo: https://github.com/python-jsonschema/check-jsonschema
|
|
67
|
+
rev: "0.34.0"
|
|
68
|
+
hooks:
|
|
69
|
+
- id: check-dependabot
|
|
70
|
+
- id: check-github-workflows
|
|
71
|
+
- id: check-readthedocs
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Read the Docs configuration file
|
|
2
|
+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
3
|
+
|
|
4
|
+
version: 2
|
|
5
|
+
|
|
6
|
+
build:
|
|
7
|
+
os: ubuntu-22.04
|
|
8
|
+
tools:
|
|
9
|
+
python: "3.11"
|
|
10
|
+
nodejs: "16"
|
|
11
|
+
jobs:
|
|
12
|
+
post_install:
|
|
13
|
+
- npm install -g @mermaid-js/mermaid-cli
|
|
14
|
+
sphinx:
|
|
15
|
+
configuration: docs/conf.py
|
|
16
|
+
|
|
17
|
+
python:
|
|
18
|
+
install:
|
|
19
|
+
- method: pip
|
|
20
|
+
path: .
|
|
21
|
+
extra_requirements:
|
|
22
|
+
- docs
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# Docker image for running gdal/ogr and fetch (wget) commands for ogdc recipes.
|
|
2
|
+
# WARNING: this image *MUST NOT* be based on busybox/alpine linux due to a known
|
|
3
|
+
# networking issue in non-local environments. For context, see:
|
|
4
|
+
# https://github.com/QGreenland-Net/ogdc-helm/issues/31
|
|
5
|
+
FROM ghcr.io/osgeo/gdal:ubuntu-small-latest
|
|
6
|
+
# We use and wget to fetch data from remote sources.
|
|
7
|
+
RUN apt update && apt install -y wget rsync
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
Copyright 2024 National Snow and Ice Data Center & Regents of the University of California
|
|
2
|
+
|
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
4
|
+
this software and associated documentation files (the "Software"), to deal in
|
|
5
|
+
the Software without restriction, including without limitation the rights to
|
|
6
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
7
|
+
of the Software, and to permit persons to whom the Software is furnished to do
|
|
8
|
+
so, subject to the following conditions:
|
|
9
|
+
|
|
10
|
+
The above copyright notice and this permission notice shall be included in all
|
|
11
|
+
copies or substantial portions of the Software.
|
|
12
|
+
|
|
13
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
14
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
15
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
16
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
17
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
18
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
19
|
+
SOFTWARE.
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ogdc-runner
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Defines OGDC recipe API(s) and submits recipes to OGDC for execution
|
|
5
|
+
Project-URL: Homepage, https://github.com/qgreenland-net/ogdc-runner
|
|
6
|
+
Project-URL: Bug Tracker, https://github.com/qgreenland-net/ogdc-runner/issues
|
|
7
|
+
Project-URL: Discussions, https://github.com/qgreenland-net/ogdc-runner/discussions
|
|
8
|
+
Project-URL: Changelog, https://github.com/qgreenland-net/ogdc-runner/releases
|
|
9
|
+
Author-email: Matt Fisher <mfisher87@gmail.com>, Rushiraj Nenuji <nenuji@nceas.ucsb.edu>, Trey Stafford <trey.stafford@colorado.edu>, Robyn Marowitz <robyn.marowitz@colorado.edu>
|
|
10
|
+
License: Copyright 2024 National Snow and Ice Data Center & Regents of the University of California
|
|
11
|
+
|
|
12
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
13
|
+
this software and associated documentation files (the "Software"), to deal in
|
|
14
|
+
the Software without restriction, including without limitation the rights to
|
|
15
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
16
|
+
of the Software, and to permit persons to whom the Software is furnished to do
|
|
17
|
+
so, subject to the following conditions:
|
|
18
|
+
|
|
19
|
+
The above copyright notice and this permission notice shall be included in all
|
|
20
|
+
copies or substantial portions of the Software.
|
|
21
|
+
|
|
22
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
23
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
24
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
25
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
26
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
27
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
28
|
+
SOFTWARE.
|
|
29
|
+
License-File: LICENSE
|
|
30
|
+
Classifier: Development Status :: 1 - Planning
|
|
31
|
+
Classifier: Intended Audience :: Developers
|
|
32
|
+
Classifier: Intended Audience :: Science/Research
|
|
33
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
34
|
+
Classifier: Operating System :: OS Independent
|
|
35
|
+
Classifier: Programming Language :: Python
|
|
36
|
+
Classifier: Programming Language :: Python :: 3
|
|
37
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
38
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
39
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
40
|
+
Classifier: Topic :: Scientific/Engineering
|
|
41
|
+
Classifier: Typing :: Typed
|
|
42
|
+
Requires-Python: >=3.11
|
|
43
|
+
Requires-Dist: click>=8
|
|
44
|
+
Requires-Dist: fsspec
|
|
45
|
+
Requires-Dist: hera>=5.18.0
|
|
46
|
+
Requires-Dist: loguru
|
|
47
|
+
Requires-Dist: pydantic>=2.7.1
|
|
48
|
+
Requires-Dist: pyyaml
|
|
49
|
+
Provides-Extra: dev
|
|
50
|
+
Requires-Dist: mypy~=1.10.0; extra == 'dev'
|
|
51
|
+
Requires-Dist: nox; extra == 'dev'
|
|
52
|
+
Requires-Dist: pytest-cov>=3; extra == 'dev'
|
|
53
|
+
Requires-Dist: pytest>=6; extra == 'dev'
|
|
54
|
+
Requires-Dist: types-pyyaml; extra == 'dev'
|
|
55
|
+
Provides-Extra: docs
|
|
56
|
+
Requires-Dist: autodoc-pydantic; extra == 'docs'
|
|
57
|
+
Requires-Dist: furo>=2023.08.17; extra == 'docs'
|
|
58
|
+
Requires-Dist: myst-parser>=0.13; extra == 'docs'
|
|
59
|
+
Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
|
|
60
|
+
Requires-Dist: sphinx-copybutton; extra == 'docs'
|
|
61
|
+
Requires-Dist: sphinx>=7.0; extra == 'docs'
|
|
62
|
+
Requires-Dist: sphinxcontrib-mermaid; extra == 'docs'
|
|
63
|
+
Provides-Extra: test
|
|
64
|
+
Requires-Dist: mypy~=1.10.0; extra == 'test'
|
|
65
|
+
Requires-Dist: pytest-cov>=3; extra == 'test'
|
|
66
|
+
Requires-Dist: pytest-order; extra == 'test'
|
|
67
|
+
Requires-Dist: pytest>=6; extra == 'test'
|
|
68
|
+
Requires-Dist: types-pyyaml; extra == 'test'
|
|
69
|
+
Description-Content-Type: text/markdown
|
|
70
|
+
|
|
71
|
+
# ogdc-runner
|
|
72
|
+
|
|
73
|
+
<!-- SPHINX-START -->
|
|
74
|
+
|
|
75
|
+
[![Actions Status][actions-badge]][actions-link]
|
|
76
|
+
[![Documentation Status][rtd-badge]][rtd-link]
|
|
77
|
+
|
|
78
|
+
[![PyPI version][pypi-version]][pypi-link]
|
|
79
|
+
[![Conda-Forge][conda-badge]][conda-link]
|
|
80
|
+
[![PyPI platforms][pypi-platforms]][pypi-link]
|
|
81
|
+
|
|
82
|
+
[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
|
|
83
|
+
|
|
84
|
+
Defines Open Geospatial Data Cloud (OGDC) recipe API(s) and submits recipes to
|
|
85
|
+
OGDC for execution.
|
|
86
|
+
|
|
87
|
+
See the [ogdc-runner ReadTheDocs](https://ogdc-runner.readthedocs.io/) for
|
|
88
|
+
detailed documentation on how to use and contribute to the `ogdc-runner`.
|
|
89
|
+
|
|
90
|
+
<!-- prettier-ignore-start -->
|
|
91
|
+
[actions-badge]: https://github.com/qgreenland-net/ogdc-runner/workflows/CI/badge.svg
|
|
92
|
+
[actions-link]: https://github.com/qgreenland-net/ogdc-runner/actions
|
|
93
|
+
[conda-badge]: https://img.shields.io/conda/vn/conda-forge/ogdc-runner
|
|
94
|
+
[conda-link]: https://github.com/conda-forge/ogdc-runner-feedstock
|
|
95
|
+
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
|
|
96
|
+
[github-discussions-link]: https://github.com/qgreenland-net/ogdc-runner/discussions
|
|
97
|
+
[pypi-link]: https://pypi.org/project/ogdc-runner/
|
|
98
|
+
[pypi-platforms]: https://img.shields.io/pypi/pyversions/ogdc-runner
|
|
99
|
+
[pypi-version]: https://img.shields.io/pypi/v/ogdc-runner
|
|
100
|
+
[rtd-badge]: https://readthedocs.org/projects/ogdc-runner/badge/?version=latest
|
|
101
|
+
[rtd-link]: https://ogdc-runner.readthedocs.io/en/latest/?badge=latest
|
|
102
|
+
<!-- prettier-ignore-end -->
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# ogdc-runner
|
|
2
|
+
|
|
3
|
+
<!-- SPHINX-START -->
|
|
4
|
+
|
|
5
|
+
[![Actions Status][actions-badge]][actions-link]
|
|
6
|
+
[![Documentation Status][rtd-badge]][rtd-link]
|
|
7
|
+
|
|
8
|
+
[![PyPI version][pypi-version]][pypi-link]
|
|
9
|
+
[![Conda-Forge][conda-badge]][conda-link]
|
|
10
|
+
[![PyPI platforms][pypi-platforms]][pypi-link]
|
|
11
|
+
|
|
12
|
+
[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
|
|
13
|
+
|
|
14
|
+
Defines Open Geospatial Data Cloud (OGDC) recipe API(s) and submits recipes to
|
|
15
|
+
OGDC for execution.
|
|
16
|
+
|
|
17
|
+
See the [ogdc-runner ReadTheDocs](https://ogdc-runner.readthedocs.io/) for
|
|
18
|
+
detailed documentation on how to use and contribute to the `ogdc-runner`.
|
|
19
|
+
|
|
20
|
+
<!-- prettier-ignore-start -->
|
|
21
|
+
[actions-badge]: https://github.com/qgreenland-net/ogdc-runner/workflows/CI/badge.svg
|
|
22
|
+
[actions-link]: https://github.com/qgreenland-net/ogdc-runner/actions
|
|
23
|
+
[conda-badge]: https://img.shields.io/conda/vn/conda-forge/ogdc-runner
|
|
24
|
+
[conda-link]: https://github.com/conda-forge/ogdc-runner-feedstock
|
|
25
|
+
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
|
|
26
|
+
[github-discussions-link]: https://github.com/qgreenland-net/ogdc-runner/discussions
|
|
27
|
+
[pypi-link]: https://pypi.org/project/ogdc-runner/
|
|
28
|
+
[pypi-platforms]: https://img.shields.io/pypi/pyversions/ogdc-runner
|
|
29
|
+
[pypi-version]: https://img.shields.io/pypi/v/ogdc-runner
|
|
30
|
+
[rtd-badge]: https://readthedocs.org/projects/ogdc-runner/badge/?version=latest
|
|
31
|
+
[rtd-link]: https://ogdc-runner.readthedocs.io/en/latest/?badge=latest
|
|
32
|
+
<!-- prettier-ignore-end -->
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
api/
|