micat 0.1.0__tar.gz

micat-0.1.0/.codespellrc

@@ -0,0 +1,17 @@
+[codespell]
+
+skip = node_modules,
+       *.git,
+       *.pyc,
+       __pycache__,
+       ./build,
+       ./dist,
+       ./htmlcov,
+       .venv,
+       *.egg-info,
+       report.xml,
+       *.yaml,
+       *.pdf,
+       public
+
+regex = [a-zA-Z0-9\-'’]+

micat-0.1.0/.gitignore

@@ -0,0 +1,23 @@
+*.egg-info
+*.pyc
+*.directory
+
+dist/
+build/
+bundle.js
+
+# Exclude results of testing the bundled images, but include
+# the yaml's beginning with "current", as they are test assets
+tests/assets/*.pdf
+tests/assets/*.yaml
+!tests/assets/current_*.yaml
+
+public/
+
+#KDE files
+*.kate-swp
+*.backup
+
+# VSC files
+.vscode/
+.venv/*

micat-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,153 @@
+stages:
+  - test
+  - expose
+  - build
+  - deploy
+
+variables:
+  USAFCAL_TEST_IMAGE: "bright"
+
+.base_job:
+  before_script:
+    - pip install -e .[dev]
+
+  rules:
+    - if: $CI_COMMIT_TAG
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_PIPELINE_SOURCE == "web"
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+    - when: never
+
+ruff:
+  extends: .base_job
+  stage: test
+  image: "python:3.11"
+  script:
+    - ruff format --diff
+    - ruff check
+
+mypy:
+  extends: .base_job
+  stage: test
+  image: "python:3.11"
+  script:
+    - mypy micat
+
+spelling:
+  extends: .base_job
+  stage: test
+  image: "python:3.11"
+  script:
+    - codespell .
+
+build-docs:
+  extends: .base_job
+  image: "python:3.11"
+  stage: build
+  script:
+    - pdoc --math micat -o public
+    - echo "JOB_ID=$CI_JOB_ID" > build-docs.env
+  artifacts:
+    expire_in: 1 week
+    name: "${CI_PROJECT_NAME}-${CI_JOB_NAME}-${CI_COMMIT_REF_NAME}-${CI_COMMIT_SHORT_SHA}-docs"
+    paths:
+      - public
+    reports:
+      dotenv: build-docs.env
+
+  # This exposes a link to the built docs.  For example in merge requests.
+  environment:
+    name: review/$CI_COMMIT_REF_SLUG
+    url: https://openflexure.gitlab.io/-/micat/-/jobs/$JOB_ID/artifacts/public/index.html
+
+usafcal-run:
+  extends: .base_job
+  stage: test
+  image: "python:3.11"
+
+  script:
+    - mkdir -p outputs/result
+    - micat usafcal tests/assets/${USAFCAL_TEST_IMAGE}.jpeg --outdir outputs/result
+    - mv outputs/result/${USAFCAL_TEST_IMAGE}_USAF_calibration.pdf outputs/result/USAF_calibration.pdf
+    - mv outputs/result/${USAFCAL_TEST_IMAGE}_USAF_calibration.yaml outputs/result/USAF_calibration.yaml
+
+  artifacts:
+    when: always
+    expire_in: 1 week
+    paths:
+      - outputs/result/*.pdf
+      - outputs/result/*.yaml
+
+# Create small image for artifact exposing
+.expose_base:
+  stage: expose
+  image: alpine:latest
+  before_script: []
+  script:
+    - echo "Exposing artifacts for MR visibility"
+  needs:
+    - job: usafcal-run
+      artifacts: true
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - when: never
+
+usafcal-pdf:
+  extends: .expose_base
+  artifacts:
+    expose_as: "Calibration PDF"
+    paths:
+      - outputs/result/USAF_calibration.pdf
+
+usafcal-yaml:
+  extends: .expose_base
+  artifacts:
+    expose_as: "Calibration YAML"
+    paths:
+      - outputs/result/USAF_calibration.yaml
+
+usafcal-e2e:
+  extends: .base_job
+  stage: test
+  image: "python:3.11"
+
+  script:
+    - echo "Running Micat E2E calibration test"
+    - python tests/end_to_end/e2e.py
+
+# Deploy jobs don't inherit from .base_job as they run at different times.
+pages:
+  dependencies:
+    - build-docs
+  needs:
+    - build-docs
+  stage: deploy
+  image: "python:3.11"
+  script:
+    # Not much to do as the files are already built and in public.
+    - echo "Deploying"
+  artifacts:
+      paths:
+      - public
+  rules:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+    - when: never
+
+pypi-publish:
+  image: "python:3.11"
+  stage: deploy
+  id_tokens:
+    PYPI_ID_TOKEN:
+      aud: pypi
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v\d+\.\d+\.\d+$/
+    - when: never
+  before_script:
+    - pip install -e .[dev]
+  script:
+    - python -m build
+    - twine upload dist/*
+  artifacts:
+    paths:
+      - dist/*.whl
+      - dist/*.tar.gz