herostools 0.3.0__tar.gz

herostools-0.3.0/.gitignore

@@ -0,0 +1,177 @@
+uv.lock
+
+.gitlab-ci-local/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+report.xml
+cobertura.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc

herostools-0.3.0/.gitlab-ci.yml

@@ -0,0 +1,170 @@
+image: "python:slim"
+
+stages:
+  - test
+  - pages
+  - build-package
+  - publish-package
+  - publish-docker
+
+variables:
+  PACKAGE_NAME: "herostools"
+  PYPI_URL: "https://gitlab.com/api/v4/projects/${CI_PROJECT_ID}/packages/pypi"
+
+
+####################################
+# build script for docker images
+.build-docker-image:
+  image: quay.io/buildah/stable
+  variables:
+    IMAGE_TAG: "latest"
+    BUILDAH_FORMAT: docker
+    STORAGE_DRIVER: vfs
+  tags:
+    - docker
+  before_script:
+    - echo "$CI_REGISTRY_PASSWORD" | buildah login -u "$CI_REGISTRY_USER" --password-stdin $CI_REGISTRY
+  script:
+    - cd "${CI_PROJECT_DIR}"
+    - buildah build --platform=linux/arm64/v8,linux/amd64 --manifest "${CI_REGISTRY_IMAGE}:${TAG_NAME}" .
+    - buildah tag "${CI_REGISTRY_IMAGE}:${TAG_NAME}" "${CI_REGISTRY_IMAGE}:latest"
+    - buildah manifest push --all "${CI_REGISTRY_IMAGE}:${TAG_NAME}"
+    - buildah manifest push --all "${CI_REGISTRY_IMAGE}:latest"
+    - buildah build --platform=linux/arm64/v8 --build-arg VARIANT=rpi --manifest "${CI_REGISTRY_IMAGE}:${TAG_NAME}-rpi" .
+    - buildah tag "${CI_REGISTRY_IMAGE}:${TAG_NAME}-rpi" "${CI_REGISTRY_IMAGE}:latest-rpi"
+    - buildah manifest push --all "${CI_REGISTRY_IMAGE}:${TAG_NAME}-rpi"
+    - buildah manifest push --all "${CI_REGISTRY_IMAGE}:latest-rpi"
+
+
+####################################
+# publish script for pypi packages
+.publish-package-to-repo:
+  stage: publish-package
+  tags:
+    - docker
+  image: "quay.io/pypa/manylinux_2_28_x86_64"
+  needs: ["build-package"]  # Ensure package is built before publishing
+  before_script:
+    - pipx install twine
+
+
+####################################
+# build
+build-package:
+  stage: build-package
+  tags:
+    - docker
+  parallel:
+    matrix:
+      - IMAGE: ["quay.io/pypa/manylinux_2_28_x86_64"]
+  image: $IMAGE
+  script:
+    - pipx install hatch
+    - hatch build  # Builds source tarball and wheel
+  artifacts:
+    paths:
+      - dist/
+  rules:
+    - if: '$CI_JOB_TRIGGER == "boss"'
+      when: never
+    - when: always
+
+
+####################################
+# test
+pytest:
+  stage: test
+  tags:
+    - docker
+  script:
+    - pip install --upgrade uv
+    - uv venv
+    - uv pip install -e .[dev]
+    - uv run pytest --color=yes --junitxml=report.xml --cov-report html --cov-report term --cov-report xml:cobertura.xml --cov=src/ tests/
+  coverage: '/(?i)total.*? (100(?:\.0+)?\%|[1-9]?\d(?:\.\d+)?\%)$/'
+  artifacts:
+      paths:
+          - htmlcov
+          - report.xml
+          - cobertura.xml
+      reports:
+          junit: report.xml
+          coverage_report:
+              coverage_format: cobertura
+              path: cobertura.xml
+  rules:
+    - if: '$CI_JOB_TRIGGER == "boss"'
+      when: never
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_COMMIT_BRANCH == "main"
+  allow_failure: true
+
+
+####################################
+# lint
+ruff:
+  stage: test
+  tags:
+    - docker
+  script:
+    - pip install --upgrade uv
+    - uv venv
+    - uv pip install -e .[dev]
+    - uv run ruff check
+  rules:
+    - if: '$CI_JOB_TRIGGER == "boss"'
+      when: never
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_COMMIT_BRANCH == "main"
+
+
+####################################
+# publish package
+publish-package-gitlab:
+  stage: publish-package
+  extends: .publish-package-to-repo
+  script:
+    - twine upload --repository-url "$PYPI_URL" -u "gitlab-ci-token" -p "$CI_JOB_TOKEN" dist/*
+  rules:
+    - if: '$CI_JOB_TRIGGER == "boss"'
+      when: never
+    - if: '$CI_COMMIT_BRANCH == "main"'
+      when: on_success
+
+
+####################################
+# docker image git commit sha with last commit from main (not on tag)
+publish-docker-main:
+  stage: publish-docker
+  extends: .build-docker-image
+  variables:
+    TAG_NAME: "$CI_COMMIT_SHORT_SHA"
+  rules:
+    - if: '$CI_COMMIT_REF_NAME == "main"'
+    - if: '$CI_PIPELINE_SOURCE == "pipeline"'
+
+
+####################################
+# publish pages
+pages:
+  stage: pages
+  tags:
+    - docker
+  script:
+    - apt-get update && apt-get install -y make
+    - pip install --upgrade uv
+    - uv venv
+    - uv pip install -e .[docs]
+    - cd docs
+    - uv run make clean && uv run make html
+    - mkdir ../public
+    - mv build/html/* ../public
+  artifacts:
+    paths:
+    - public
+  rules:
+    - if: '$CI_JOB_TRIGGER == "boss"'
+      when: never
+    - if: '$CI_COMMIT_BRANCH == "main"'
+      when: on_success
+

herostools-0.3.0/.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+repos:
+  - repo: local
+    hooks:
+      - id: ruff-check
+        name: Ruff Linter
+        language: python
+        types: [python]
+        entry: ruff check --fix
+        require_serial: true
+        stages: [pre-commit, pre-push, manual]
+      - id: ruff-format
+        name: Ruff Formatter
+        language: python
+        types: [python]
+        entry: ruff format
+        require_serial: true
+        stages: [pre-commit, pre-push, manual]
+      - id: codespell
+        name: Find Spelling Errors
+        language: python
+        entry: codespell
+        stages: [pre-commit, pre-push, manual]
+        additional_dependencies: [codespell]
+      - id: mypy
+        name: MyPy Typing and more
+        language: python
+        types: [python]
+        entry: mypy
+        stages: [manual]
+        additional_dependencies: [mypy]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.2.0
+    hooks:
+      - id: check-ast
+      - id: check-added-large-files
+      - id: check-docstring-first
+      - id: detect-private-key
+      - id: trailing-whitespace
+

herostools-0.3.0/Dockerfile

@@ -0,0 +1,13 @@
+# #########################################################################################
+# Build image with everything required to run the tools
+# #########################################################################################
+
+FROM registry.gitlab.com/atomiq-project/boss
+
+# Copy the contents of the repository into the image
+WORKDIR /git
+COPY . herostools
+
+# Install herostools in editable mode
+RUN pip install --break-system-packages -e herostools
+