qiclib 2.3.0__tar.gz

qiclib-2.3.0/.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Initial formatting of whole repo with black & pre-commit
+de508d83934384a0ef1ad3289fc11245ffbf572d

qiclib-2.3.0/.gitignore

@@ -0,0 +1,181 @@
+build
+dist
+docs/qiclib
+
+*.egg-info
+.idea
+/venv/
+
+# 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
+
+# Generated documentation
+docs/_build
+
+# 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
+tests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# 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
+
+# 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/#use-with-ide
+.pdm.toml
+
+# Dynamically generated version.py file
+src/qiclib/_version.py
+
+# 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/
+
+# Journal files
+*.jou
+
+# Local notebooks using qiclib in this
+Notebooks/*

qiclib-2.3.0/.gitlab-ci.yml

@@ -0,0 +1,154 @@
+variables:
+  GIT_SUBMODULE_STRATEGY: recursive
+  GIT_SUBMODULE_FORCE_HTTPS: true
+  UV_VERSION: '0.9'
+  PYTHON_VERSION: '3.10'
+  BASE_LAYER: bookworm
+  UV_SYSTEM_PYTHON: 1
+  GITHUB_PUBLISH_USER: quantuminterfaceBot
+  GITHUB_PUBLISH_REPO: quantuminterface/qiclib
+
+stages: [analysis, test, build, deploy]
+
+default:
+  image: ghcr.io/astral-sh/uv:$UV_VERSION-python$PYTHON_VERSION-$BASE_LAYER
+
+.base_ruff:
+  interruptible: true
+  before_script:
+    - export UV_TOOL_BIN_DIR=/usr/local/bin
+    - cd $CI_PROJECT_DIR
+
+unit_tests:
+  extends: .base_ruff
+  stage: test
+  script:
+    - uv run pytest --junitxml tests.xml --cov=qiclib --cov-fail-under=50 --cov-report xml --cov-report term
+  coverage: "/TOTAL.+ ([0-9]{1,3}%)/"
+  artifacts:
+    when: always
+    paths:
+      - tests.xml
+    reports:
+      junit:
+        - tests.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+
+check_format:
+  extends: .base_ruff
+  stage: analysis
+  variables:
+    PRE_COMMIT_HOME: ${CI_PROJECT_DIR}/.cache/pre-commit
+  cache:
+    paths:
+      - ${PRE_COMMIT_HOME}
+  script:
+    - git config --global --add safe.directory '*'
+    - uvx pre-commit run --all-files
+
+check_mypy:
+  extends: .base_ruff
+  stage: analysis
+  script:
+    - uv run mypy src --junit-xml mypy.xml --install-types --non-interactive --check-untyped-defs
+  artifacts:
+    when: on_failure
+    paths:
+      - mypy.xml
+    reports:
+      junit: mypy.xml
+
+check_ruff:
+  extends: .base_ruff
+  stage: analysis
+  script:
+    - uv run ruff check --output-format junit > ruff.xml
+  artifacts:
+    when: on_failure
+    paths:
+      - ruff.xml
+    reports:
+      junit: ruff.xml
+
+pylint:
+  extends: .base_ruff
+  stage: analysis
+  before_script:
+    - mkdir -p public/badges
+    - echo undefined > public/badges/$CI_JOB_NAME.score
+  script:
+    - uv run pylint --exit-zero --output-format=text src | tee /tmp/pylint.txt
+    - sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p' /tmp/pylint.txt > public/badges/$CI_JOB_NAME.score
+    - uv run --with pylint-gitlab pylint --exit-zero --output-format=pylint_gitlab.GitlabCodeClimateReporter src > codeclimate.json
+  after_script:
+    - uvx anybadge --overwrite --label $CI_JOB_NAME --value=$(cat public/badges/$CI_JOB_NAME.score) --file=public/badges/$CI_JOB_NAME.svg 4=red 6=orange 8=yellow 10=green
+    - |
+      echo "Your score is: $(cat public/badges/$CI_JOB_NAME.score)"
+  artifacts:
+    paths:
+      - public
+    reports:
+      codequality: codeclimate.json
+    when: always
+
+build_project:
+  extends: .base_ruff
+  stage: build
+  script:
+    - uv build
+    - uvx twine check dist/*
+  artifacts:
+    paths:
+      - dist/
+    when: on_success
+
+mirror_to_github:
+  stage: deploy
+  rules:
+    # Run only for tags matching semver like v1.2.3, v2.0.0-rc.1, v1.0.0+build123, etc.
+    - if: '$CI_COMMIT_TAG =~ /^v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?$/'
+  script:
+    - VERSION="$CI_COMMIT_TAG"
+    - echo "Preparing release $VERSION for GitHub mirror"
+
+    # Prepare a clean directory with the repository contents
+    - mkdir ../mirror
+    - git archive "$VERSION" | tar -x -C ../mirror
+    - cd ../mirror
+    - git init --initial-branch=main
+
+    # Git Identity
+    - git config user.email "quantuminterface@ipe.kit.edu"
+    - git config user.name "Quantuminterface Bot"
+
+    # Pull existing history from GitHub
+    - git remote add origin "https://${GITHUB_PUBLISH_USER}:${GITHUB_PUBLISH_TOKEN}@github.com/${GITHUB_PUBLISH_REPO}.git"
+    - git fetch origin main
+    - git checkout -B main
+    - git reset --soft origin/main
+
+    # Commit the new release snapshot
+    - git add -A
+    - git commit -m "Release $VERSION"
+
+    # Tag and push both branch and tag
+    - git tag "$VERSION"
+    - git push origin main
+    - git push origin "$VERSION"
+
+publish_to_pypi:
+  stage: deploy
+  needs:
+    - build_project
+  rules:
+    - if: '$CI_COMMIT_TAG =~ /^v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?$/'
+  script:
+    - echo "Publishing version $CI_COMMIT_TAG to PyPI"
+
+    # Build the wheel and sdist
+    - uv build
+
+    # Publish to PyPI
+    - uv publish --token "$PYPI_PUBLISH_TOKEN"

qiclib-2.3.0/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "src/qiclib/packages/grpc/ipe_servicehub_protos"]
+	path = src/qiclib/packages/grpc/ipe_servicehub_protos
+	url = ../ipe_servicehub_protos.git

qiclib-2.3.0/.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.3
+    hooks:
+      # Run the linter.
+      - id: ruff
+        types_or: [ python, pyi, jupyter ]
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format

qiclib-2.3.0/.pylintrc

@@ -0,0 +1,13 @@
+[MAIN]
+ignore-paths = src/qiclib/packages/grpc/
+py-version = 3.6
+fail-under = 8.0
+
+[FORMAT]
+max-line-length = 120
+
+[MESSAGES CONTROL]
+disable=no-else-return,no-else-continue
+
+[TYPECHECK]
+ignored-modules=scipy.special

qiclib-2.3.0/.python-version

@@ -0,0 +1 @@
+3.10

qiclib-2.3.0/.vscode/extensions.json

@@ -0,0 +1,13 @@
+{
+  "recommendations": [
+    "charliermarsh.ruff",
+    "ms-python.python",
+    "ms-python.debugpy",
+    "tamasfe.even-better-toml",
+    "ms-toolsai.jupyter",
+    "donjayamanne.vscode-default-python-kernel",
+    "GitLab.gitlab-workflow",
+    "redhat.vscode-yaml",
+    "zxh404.vscode-proto3"
+  ]
+}

qiclib-2.3.0/.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+    "editor.formatOnSave": true,
+    "editor.detectIndentation": false,
+    "editor.tabSize": 4,
+    "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
+    "python.analysis.autoSearchPaths": true,
+    "python.analysis.extraPaths": [
+        "${workspaceFolder}"
+    ],
+    "python.testing.pytestEnabled": true,
+    "python.testing.unittestEnabled": false,
+    "python.testing.cwd": "${workspaceFolder}/tests",
+    "python.testing.pytestPath": "${workspaceFolder}/.venv/bin/pytest",
+    "python.testing.autoTestDiscoverOnSaveEnabled": true
+}