polarion-rest-api-client 1.0.0__tar.gz

polarion_rest_api_client-1.0.0/.git_archival.txt

@@ -0,0 +1,7 @@
+Copyright DB InfraGO AG and contributors
+SPDX-License-Identifier: CC0-1.0
+
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true)$
+ref-names: $Format:%D$

polarion_rest_api_client-1.0.0/.gitattributes

@@ -0,0 +1,11 @@
+# Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: CC0-1.0
+
+* text=auto
+
+*.{cmd,[cC][mM][dD]} text eol=crlf
+*.{bat,[bB][aA][tT]} text eol=crlf
+
+*.{sh,py} text eol=lf
+
+.git_archival.txt  export-subst

polarion_rest_api_client-1.0.0/.github/workflows/build-test-publish.yml

@@ -0,0 +1,91 @@
+# Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: CC0-1.0
+
+name: Build
+
+on:
+  push:
+    branches: ["*"]
+    pull_request: [main]
+    tags: ["v*.*.*"]
+
+jobs:
+  test:
+    name: Test with Python ${{matrix.python_version}} on ${{matrix.os}}
+    runs-on: ${{matrix.os}}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python_version:
+          - "3.10"
+          - "3.11"
+          - "3.12"
+        include:
+          - os: windows-latest
+            python_version: "3.12"
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{matrix.python_version}}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{matrix.python_version}}
+      - uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{runner.os}}-pip-${{hashFiles('pyproject.toml')}}
+          restore-keys: |
+            ${{runner.os}}-pip-
+            ${{runner.os}}-
+      - name: Upgrade Pip
+        run: |-
+          python -m pip install -U pip
+      - name: Install test dependencies
+        run: |-
+          python -m pip install '.[test]'
+      - name: Run unit tests
+        run: |-
+          python -m pytest --cov-report=term --cov=polarion_rest_api_client --rootdir=.
+  build:
+    name: Build wheel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          cache: pip
+          cache-dependency-path: pyproject.toml
+          python-version: "3.12"
+      - name: Install dependencies
+        run: python -m pip install -U pip build twine
+      - name: Build packages
+        run: python -m build
+      - name: Verify packages
+        run: python -m twine check dist/*
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+          if-no-files-found: error
+  pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: [build, test]
+    if: startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main'
+    environment:
+      name: pypi
+      url: https://pypi.org/project/polarion-open-api-client
+    permissions:
+      id-token: write
+    steps:
+      - name: Download built wheel
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

polarion_rest_api_client-1.0.0/.github/workflows/docs.yml

@@ -0,0 +1,39 @@
+# Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: CC0-1.0
+
+name: Docs
+
+on:
+  push:
+    branches: ["master"]
+
+jobs:
+  sphinx:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v3
+        with:
+          python-version: "3.9"
+      - name: Upgrade pip
+        run: |
+          python -m pip install -U pip
+      - name: Install dependencies
+        run: |
+          python -m pip install '.[docs]'
+      - name: Auto-generate APIDOC sources
+        run: |-
+          sphinx-apidoc --output-dir docs/source/code --force . polarion_rest_api_client/open_api_client
+      - name: Create docs
+        run: |
+          make -C docs html
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          force_orphan: true
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build/html

polarion_rest_api_client-1.0.0/.github/workflows/lint.yml

@@ -0,0 +1,42 @@
+# Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: CC0-1.0
+
+name: Lint
+
+on:
+  push:
+    branches: ["*"]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+        with:
+          python-version: "3.12"
+      - name: Upgrade pip
+        run: |-
+          python -m pip install -U pip
+      - name: Install pre-commit
+        run: |-
+          python -m pip install pre-commit types-docutils
+      - name: Run Pre-Commit
+        run: |-
+          pre-commit run --all-files
+  pylint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.12"
+      - name: Upgrade pip
+        run: |-
+          python -m pip install -U pip
+      - name: Install pylint
+        run: |-
+          python -m pip install pylint
+      - name: Run pylint
+        run: |-
+          pylint -dfixme polarion_rest_api_client tests || exit $(($? & ~24))

polarion_rest_api_client-1.0.0/.gitignore

@@ -0,0 +1,164 @@
+# Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: CC0-1.0
+
+# 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
+
+# IDE
+.vscode
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.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/
+docs/source/code/
+docs/source/_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
+
+# 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
+
+# VS Code settings
+.vscode/
+
+# 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/

polarion_rest_api_client-1.0.0/.gitlab-ci.yml

@@ -0,0 +1,45 @@
+# Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: Apache-2.0
+
+stages:
+  - build
+  - test
+  - deploy
+
+wheel:
+  stage: build
+  extends: .wheel
+
+coverage:
+  stage: test
+  extends: .coverage
+  variables:
+    COVERAGE_SOURCE: polarion_rest_api_client
+  needs: []
+
+pre-commit:
+  stage: test
+  extends: .pre-commit
+  needs: []
+
+artifactory:
+  stage: deploy
+  extends: .artifactory
+  needs:
+    - job: wheel
+      artifacts: true
+    - job: coverage
+    - job: pre-commit
+  rules:
+    - if: $CI_COMMIT_TAG
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+
+include:
+  - project: "se-toolchain/ci-templates-docker"
+    ref: master
+    file:
+      - "/gitlab-ci/docker/upload-registry.yml"
+      - "/gitlab-ci/generic/pre-commit.yml"
+      - "/gitlab-ci/python/sphinx.yml"
+      - "/gitlab-ci/python/test.yml"
+      - "/gitlab-ci/python/wheel.yml"

polarion_rest_api_client-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,108 @@
+# Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: CC0-1.0
+
+default_install_hook_types: [commit-msg, pre-commit]
+default_stages: [commit, merge-commit]
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-builtin-literals
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: check-toml
+      - id: check-vcs-permalinks
+      - id: check-xml
+      - id: check-yaml
+      - id: debug-statements
+      - id: destroyed-symlinks
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: trailing-whitespace
+  - repo: https://github.com/psf/black
+    rev: 24.4.2
+    hooks:
+      - id: black
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+  - repo: https://github.com/PyCQA/docformatter
+    rev: v1.7.5
+    hooks:
+      - id: docformatter
+        additional_dependencies:
+          - docformatter[tomli]
+  - repo: https://github.com/PyCQA/pydocstyle
+    rev: 6.3.0
+    hooks:
+      - id: pydocstyle
+        exclude: "^tests/|polarion_rest_api_client/open_api_client/"
+        additional_dependencies:
+          - pydocstyle[toml]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.10.0
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - types-requests
+          - types-PyYAML
+          - types-python-dateutil
+          - attrs
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.5.5
+    hooks:
+      - id: insert-license
+        name: Insert license headers (shell-style comments)
+        files: '(?:^|/)(?:.*\.(?:py|sh|toml|ya?ml)|Dockerfile|Makefile)$'
+        exclude: '(?:^|/)\..+|^docs/Makefile$'
+        args:
+          - --detect-license-in-X-top-lines=15
+          - --license-filepath
+          - LICENSES/.license_header.txt
+          - --comment-style
+          - '#'
+      - id: insert-license
+        name: Insert license headers (XML-style comments)
+        files: '\.(?:html|md|xml)$'
+        exclude: '(?:^|/)\..+'
+        args:
+          - --detect-license-in-X-top-lines=15
+          - --license-filepath
+          - LICENSES/.license_header.txt
+          - --comment-style
+          - '<!--| ~| -->'
+      - id: insert-license
+        name: Insert license headers (C-style comments)
+        files: '\.(?:css|js|ts)$'
+        exclude: '(?:^|/)\..+'
+        args:
+          - --detect-license-in-X-top-lines=15
+          - --license-filepath
+          - LICENSES/.license_header.txt
+          - --comment-style
+          - '/*| *| */'
+      - id: insert-license
+        name: Insert license headers (reST comments)
+        files: '\.rst$'
+        exclude: '(?:^|/)\..+'
+        args:
+          - --detect-license-in-X-top-lines=15
+          - --license-filepath
+          - LICENSES/.license_header.txt
+          - --comment-style
+          - '..|  |'
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v3.0.2
+    hooks:
+      - id: reuse
+  - repo: https://github.com/qoomon/git-conventional-commits
+    rev: v2.6.7
+    hooks:
+      - id: conventional-commits

polarion_rest_api_client-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,161 @@
+<!--
+ ~ Copyright DB InfraGO AG and contributors
+ ~ SPDX-License-Identifier: Apache-2.0
+ -->
+
+# Contributing
+
+Thanks for your interest in our project. Contributions are always welcome!
+
+We are committed to fostering a welcoming, respectful, and harassment-free
+environment. Be kind!
+
+If you have questions, ideas or want to report a bug, feel free to [open an
+issue]. Or go ahead and [open a pull request] to contribute code. In order to
+reduce the burden on our maintainers, please make sure that your code follows
+our style guidelines outlined below.
+
+<!-- prettier-ignore -->
+[open an issue]:
+  https://github.com/DSD-DBS/polarion-rest-api-client/issues
+[open a pull request]:
+  https://github.com/DSD-DBS/polarion-rest-api-client/pulls
+
+## Developing
+
+We recommend that you
+[develop inside of a virtual environment](README.md#installation). After you
+have set it up, simply run the unit tests to verify that everything is set up
+correctly:
+
+```zsh
+pytest
+```
+
+We additionally recommend that you set up your editor / IDE as follows.
+
+- Indent with 4 spaces per level of indentation
+
+- Maximum line length of 79 (add a ruler / thin line / highlighting / ...)
+
+- _If you use Visual Studio Code_: Consider using a platform which supports
+  third-party language servers more easily, and continue with the next point.
+
+  Otherwise, set up the editor to run `black`, `pylint` and `mypy` when saving.
+  To enable automatic import sorting with `isort`, add the following to your
+  `settings.json`:
+
+  ```json
+  "[python]": {
+      "editor.codeActionsOnSave": {
+          "source.organizeImports": true
+      }
+  }
+  ```
+
+  Note that the Pylance language server is not recommended, as it occasionally
+  causes false-positive errors for perfectly valid code.
+
+- _If you do not use VSC_: Set up your editor to use the [python-lsp-server],
+  and make sure that the relevant plugins are installed. You can install
+  everything that's needed into the virtualenv with pip:
+
+  [python-lsp-server]: https://github.com/python-lsp/python-lsp-server
+
+  ```zsh
+  pip install "python-lsp-server[pylint]" python-lsp-black pyls-isort pylsp-mypy
+  ```
+
+  This will provide as-you-type linting as well as automatic formatting on
+  save. Language server clients are available for a wide range of editors, from
+  Vim/Emacs to PyCharm/IDEA.
+
+## Code style
+
+We base our code style on a modified version of the
+[Google style guide for Python code](https://google.github.io/styleguide/pyguide.html).
+The key differences are:
+
+- **Docstrings**: The [Numpy style guide] applies here.
+
+  [numpy style guide]:
+    https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard
+
+  When writing docstrings for functions, use the imperative style, as per
+  [PEP-257]). For example, write "Do X and Y" instead of "Does X and Y".
+
+  [pep-257]: https://peps.python.org/pep-0257/
+
+- **Overridden methods**: If the documentation did not change from the base
+  class (i.e. the base class' method's docstring still applies without
+  modification), do not add a short docstring á la "See base class". This lets
+  automated tools pick up the full base class docstring instead, and is
+  therefore more useful in IDEs etc.
+
+- **Linting**: Use [pylint] for static code analysis, and [mypy] for static
+  type checking.
+
+  [pylint]: https://github.com/PyCQA/pylint
+  [mypy]: https://github.com/python/mypy
+
+- **Formatting**: Use [black] as code auto-formatter. The maximum line length
+  is 79, as per [PEP-8]. This setting should be automatically picked up from
+  the `pyproject.toml` file. The reason for the shorter line length is that it
+  avoids wrapping and overflows in side-by-side split views (e.g. diffs) if
+  there's also information displayed to the side of it (e.g. a tree view of the
+  modified files).
+
+  [black]: https://github.com/psf/black
+  [pep-8]: https://www.python.org/dev/peps/pep-0008/
+
+  Be aware of the different line length of 72 for docstrings. We currently do
+  not have a satisfactory solution to automatically apply or enforce this.
+
+  Note that, while you're encouraged to do so in general, it is not a hard
+  requirement to break up long strings into smaller parts. Additionally, never
+  break up strings that are presented to the user in e.g. log messages, as that
+  makes it significantly harder to grep for them.
+
+  Use [isort] for automatic sorting of imports. Its settings should
+  automatically be picked up from the `pyproject.toml` file as well.
+
+  [isort]: https://github.com/PyCQA/isort
+
+- **Typing**: We do not make an exception for `typing` imports. Instead of
+  writing `from typing import SomeName`, use `import typing as t` and access
+  typing related classes like `t.TypedDict`.
+
+  <!-- prettier-ignore -->
+
+  Use the new syntax and classes for typing introduced with Python 3.10 and available using
+  `from __future__ import annotations` since Python 3.8.
+
+  Be aware however that this only works in the context of annotations; the code
+  still needs to run on Python 3.9! This means that in some (rare) cases, you _must_ use the
+  old-style type hints.
+
+  - Instead of `t.Tuple`, `t.List` etc. use the builtin classes `tuple`, `list`
+    etc.
+  - For classes that are not builtin (e.g. `Iterable`),
+    `import collections.abc as cabc` and then use them like `cabc.Iterable`.
+  - Use [PEP-604-style unions], e.g. `int | float` instead of
+    `t.Union[int, float]`.
+  - Use `... | None` (with `None` always as the last union member) instead of
+    `t.Optional[...]` and always explicitly annotate where `None` is possible.
+
+  [pep-604-style unions]: https://www.python.org/dev/peps/pep-0604/
+
+- **Python style rules**: For conflicting parts, the [Black code style] wins.
+  If you have set up black correctly, you don't need to worry about this though
+  :)
+
+  [black code style]:
+    https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html
+
+- When working with `dict`s, consider using `t.TypedDict` instead of a more
+  generic `dict[str, float|int|str]`-like annotation where possible, as the
+  latter is much less precise (often requiring additional `assert`s or
+  `isinstance` checks to pass) and can grow unwieldy very quickly.
+
+- Prefer `t.NamedTuple` over `collections.namedtuple`, because the former uses
+  a more convenient `class ...:` syntax and also supports type annotations.

polarion_rest_api_client-1.0.0/LICENSES/.license_header.txt

@@ -0,0 +1,2 @@
+Copyright DB InfraGO AG and contributors
+SPDX-License-Identifier: Apache-2.0