cmsdials 1.7.0__tar.gz → 1.7.2__tar.gz

cmsdials-1.7.2/.editorconfig

@@ -0,0 +1,20 @@
+# For VSCode install the extension: https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+end_of_line = lf
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab
+
+[*.{yml,yaml,json}]
+indent_size = 2

cmsdials-1.7.2/.gitignore

@@ -0,0 +1,167 @@
+# 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
+.cache-dev
+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/
+
+# 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
+
+# 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/
+
+# uv
+uv.lock
+
+# setuptools_scm
+cmsdials/_version.py

cmsdials-1.7.2/.gitlab-ci.yml

@@ -0,0 +1,113 @@
+stages:
+  - test
+  - build
+  - publish
+  - create_release
+
+test_matrix:
+  stage: test
+  parallel:
+    matrix:
+      - PYTHON_VERSION: ["3.9", "3.10", "3.11", "3.12"]
+  image: registry.cern.ch/docker.io/library/python:$PYTHON_VERSION
+  before_script:
+    - python -m pip install --upgrade pip
+    - pip install uv
+    - uv sync --all-groups --extra pandas --extra tqdm
+  script:
+    - uv run pytest tests --cov=cmsdials --cov-report=xml --cov-report=term
+  coverage: "/TOTAL.+ ([0-9]{1,3}%)/"
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+  variables:
+    SECRET_KEY: "$SECRET_KEY"
+
+build:
+  stage: build
+  image: registry.cern.ch/docker.io/library/python:3.12
+  before_script:
+    - python -m pip install --upgrade pip
+    - pip install uv
+    - uv sync --all-groups --extra pandas --extra tqdm
+  script:
+    - rm -rf dist/
+    - uv build
+  artifacts:
+    paths:
+      - dist/
+    expire_in: 1 hour
+  needs:
+    - test_matrix
+
+publish:
+  stage: publish
+  image: registry.cern.ch/docker.io/library/python:3.12
+  rules:
+    - if: '$CI_COMMIT_TAG'
+      when: always
+    - when: never
+  before_script:
+    - python -m pip install --upgrade pip
+    - pip install uv
+  script:
+    - uv publish  # UV_PUBLISH_TOKEN has to be set in CI/CD variables
+  needs:
+    - build
+
+create_release:
+  stage: create_release
+  image: registry.cern.ch/registry.gitlab.com/gitlab-org/cli:latest
+  rules:
+    - if: $CI_COMMIT_TAG
+  variables:
+    GITLAB_HOST: $CI_SERVER_FQDN
+  before_script:
+    - apk add jq --no-cache
+  script:
+    - |
+      set -x
+
+      # Fetch all tags
+      git fetch --tags
+
+      # Get the previous tag
+      PREV_TAG=$(git describe --tags --abbrev=0 ${CI_COMMIT_TAG}^)
+      echo "Generating release for ${CI_COMMIT_TAG} (MRs since ${PREV_TAG})"
+
+      # Setup auth
+      glab auth login --token "$GITLAB_TOKEN"
+
+      # Generate release notes
+      echo "### Changes since ${PREV_TAG}:" > release_notes.md
+      echo "" >> release_notes.md
+      echo "[${PREV_TAG}...${CI_COMMIT_TAG}]($CI_PROJECT_URL/-/compare/${PREV_TAG}...${CI_COMMIT_TAG})" >> release_notes.md
+      echo "" >> release_notes.md
+
+      # Get MR numbers between the two tags by parsing commit messages
+      MR_NUMBERS=$(git log $PREV_TAG..$CI_COMMIT_TAG --merges --pretty=format:"%b" | grep -oE '!([0-9]+)' | tr -d '!' | sort -u)
+
+      # Update release notes, fallback to commit list if merge request list is empty
+      # The default merge commit message has this at the end: See merge request gamoreir/test-release-ci!3
+      if [ -z "$MR_NUMBERS" ]; then
+        COMMIT_LIST=$(git log --pretty=format:"- #%h from %an <%ae>: %s" ${PREV_TAG}..${CI_COMMIT_TAG})
+        echo "${COMMIT_LIST}" >> release_notes.md
+      else
+        for mr in $MR_NUMBERS; do
+          echo "Fetching MR $mr metadata"
+          mr_metadata=$(glab mr view "$mr" -R "$CI_PROJECT_PATH" -F json)
+          mr_web_url=$(echo "$mr_metadata" | jq -r '.web_url')
+          title=$(echo "$mr_metadata" | jq -r '.title')
+          author_username=$(echo "$mr_metadata" | jq -r '.author.username')
+          author_username_web_url=$(echo "$mr_metadata" | jq -r '.author.web_url')
+          echo "- [!${mr}](${mr_web_url}) from [@${author_username}](${author_username_web_url}): ${title}" >> release_notes.md
+        done
+      fi
+
+      # Create the release
+      echo "Creating release for tag $CI_COMMIT_TAG"
+      glab release create "${CI_COMMIT_TAG}" -R "$CI_PROJECT_PATH" -F release_notes.md
+  needs:
+    - publish

cmsdials-1.7.2/.mailmap

@@ -0,0 +1,2 @@
+Gabriel Moreira <gabriel.moreira@cern.ch> <gabrielmscampos@gmail.com>
+Yueh-Shun Li <yueh-shun.li@cern.ch> <shamrocklee@posteo.net>

cmsdials-1.7.2/.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-added-large-files
+        args: ["--maxkb=500"]
+        exclude: >
+            (?x)^(
+                package-lock\.json
+                poetry\.lock
+            )$
+      - id: fix-byte-order-marker
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: debug-statements
+      - id: detect-private-key
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.2
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

cmsdials-1.7.2/.tool-versions

@@ -0,0 +1 @@
+python 3.12.9 3.11.10 3.10.13 3.9.19

{cmsdials-1.7.0 → cmsdials-1.7.2}/PKG-INFO

@@ -1,29 +1,25 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: cmsdials
-Version: 1.7.0
+Version: 1.7.2
 Summary: The Python api client interface to DIALS service
-Home-page: https://github.com/cms-DQM/dials-py
-Author: Gabriel Moreira
-Author-email: gabrielmscampos@gmail.com
-Requires-Python: >=3.9,<4.0
+Author-email: Gabriel Moreira <gabriel.moreira@cern.ch>
+Project-URL: Repository, https://gitlab.cern.ch/cms-dqmdc/libraries/dials-py
 Classifier: Development Status :: 5 - Production/Stable
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3.0.0,>=2.31.0
+Requires-Dist: urllib3<2.0.0,>=1.26.16
+Requires-Dist: pydantic<3.0.0,>=2.8.2
 Provides-Extra: pandas
+Requires-Dist: pandas>=1.5.3; extra == "pandas"
 Provides-Extra: tqdm
-Requires-Dist: pandas (>=1.5.3) ; extra == "pandas"
-Requires-Dist: pydantic (>=2.8.2,<3.0.0)
-Requires-Dist: requests (>=2.31.0,<3.0.0)
-Requires-Dist: tqdm (>=4.66.1) ; extra == "tqdm"
-Requires-Dist: urllib3 (>=1.26.16,<2.0.0)
-Project-URL: Repository, https://github.com/cms-DQM/dials-py
-Description-Content-Type: text/markdown
+Requires-Dist: tqdm>=4.66.1; extra == "tqdm"
+Dynamic: license-file
 
 ![Build Status](https://gitlab.cern.ch/cms-dqmdc/libraries/dials-py/badges/dev/pipeline.svg)
 ![Coverage](https://gitlab.cern.ch/cms-dqmdc/libraries/dials-py/badges/dev/coverage.svg)
@@ -354,3 +350,34 @@ asdf set python 3.12.9 3.11.10 3.10.13 3.9.19
 
 This will use `3.12.9` by default (if you just run `python`), but it will also put `python3.11`, `python3.10` and `python3.9` symlinks in your path so you can run those too (which is exactly what tox is looking for).
 
+## Releasing the package on PyPI
+
+### Build
+
+You can use poetry to build the package using:
+
+```bash
+poetry build
+```
+
+The build system requires `poetry-dynamic-versioning` plugin installed to update the package version during build time. To install this plugin simply:
+
+```
+poetry self add "poetry-dynamic-versioning[plugin]"
+```
+
+The build system will automatically update the package version based on the git tag of the current commit.
+
+### Publish
+
+To publish the package will need maintainer rights to the `cmsdials` page in PyPI and configure your poetry installation to publish with a PyPI api token. Provided you have already generate a PyPI api token in your account you can configure your poetry installation using:
+
+```
+poetry config pypi-token.pypi <your-api-token>
+```
+
+Then, to build and publish in one go you can do:
+
+```bash
+poetry publish --build
+```

{cmsdials-1.7.0 → cmsdials-1.7.2}/README.md

@@ -326,3 +326,35 @@ asdf set python 3.12.9 3.11.10 3.10.13 3.9.19
 ```
 
 This will use `3.12.9` by default (if you just run `python`), but it will also put `python3.11`, `python3.10` and `python3.9` symlinks in your path so you can run those too (which is exactly what tox is looking for).
+
+## Releasing the package on PyPI
+
+### Build
+
+You can use poetry to build the package using:
+
+```bash
+poetry build
+```
+
+The build system requires `poetry-dynamic-versioning` plugin installed to update the package version during build time. To install this plugin simply:
+
+```
+poetry self add "poetry-dynamic-versioning[plugin]"
+```
+
+The build system will automatically update the package version based on the git tag of the current commit.
+
+### Publish
+
+To publish the package will need maintainer rights to the `cmsdials` page in PyPI and configure your poetry installation to publish with a PyPI api token. Provided you have already generate a PyPI api token in your account you can configure your poetry installation using:
+
+```
+poetry config pypi-token.pypi <your-api-token>
+```
+
+Then, to build and publish in one go you can do:
+
+```bash
+poetry publish --build
+```

cmsdials-1.7.2/cmsdials/_version.py

@@ -0,0 +1,21 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '1.7.2'
+__version_tuple__ = version_tuple = (1, 7, 2)

{cmsdials-1.7.0 → cmsdials-1.7.2}/cmsdials/auth/bearer.py

@@ -31,7 +31,7 @@ class Credentials(BaseCredentials):
         refresh_expires_in: int,
         refresh_token: str,
         token_type: str,
-        cache_dir: str = DEFAULT_CACHE_DIR,
+        cache_dir: Optional[str] = None,
         client: Optional[AuthClient] = None,
     ):
         # Load parent class and overwrite token attributes
@@ -45,7 +45,7 @@ class Credentials(BaseCredentials):
         self.token_type = token_type
 
         # Setup dir for caching credentials and authentication client
-        self.cache_dir = cache_dir
+        self.cache_dir = cache_dir or DEFAULT_CACHE_DIR
         self.client = client or AuthClient()
 
         # If loaded token is expired, immediately refresh
@@ -75,7 +75,7 @@ class Credentials(BaseCredentials):
         )
 
     @staticmethod
-    def _handle_creds_filepath(cache_dir: str = DEFAULT_CACHE_DIR):
+    def _handle_creds_filepath(cache_dir: Optional[str] = None):
         cache_dir = cache_dir or DEFAULT_CACHE_DIR
         if os.path.isabs(cache_dir) is False:
             cache_dir = os.path.join(os.getcwd(), cache_dir)
@@ -85,9 +85,10 @@ class Credentials(BaseCredentials):
 
     @staticmethod
     def from_authclient_token(
-        token: Token, cache_dir: str = DEFAULT_CACHE_DIR, client: Optional[AuthClient] = None
+        token: Token, cache_dir: Optional[str] = None, client: Optional[AuthClient] = None
     ) -> "Credentials":
         client = client or AuthClient()
+        cache_dir = cache_dir or DEFAULT_CACHE_DIR
         return Credentials(
             token=token.access_token,
             expires_in=token.expires_in,
@@ -101,8 +102,9 @@ class Credentials(BaseCredentials):
         )
 
     @staticmethod
-    def from_creds_file(cache_dir: str = DEFAULT_CACHE_DIR, client: Optional[AuthClient] = None) -> "Credentials":
+    def from_creds_file(cache_dir: Optional[str] = None, client: Optional[AuthClient] = None) -> "Credentials":
         client = client or AuthClient()
+        cache_dir = cache_dir or DEFAULT_CACHE_DIR
         fpath = Credentials._handle_creds_filepath(cache_dir)
         try:
             with open(fpath) as filebuffer:

{cmsdials-1.7.0 → cmsdials-1.7.2}/cmsdials/auth/client.py

@@ -23,10 +23,7 @@ class AuthClient(BaseAPIClient):
         endpoint_url = self.api_url + "auth/new-device/"
         response = requests.get(
             url=endpoint_url,
-            headers={
-                "accept": "application/json",
-                "User-Agent": self._build_user_agent()
-            },
+            headers={"accept": "application/json", "User-Agent": self._build_user_agent()},
             timeout=self.default_timeout,
         )
         response.raise_for_status()
@@ -40,7 +37,7 @@ class AuthClient(BaseAPIClient):
             headers={
                 "accept": "application/json",
                 "Content-Type": "application/json",
-                "User-Agent": self._build_user_agent()
+                "User-Agent": self._build_user_agent(),
             },
             json={"device_code": device_code},
             timeout=self.default_timeout,
@@ -67,7 +64,7 @@ class AuthClient(BaseAPIClient):
                 "accept": "application/json",
                 "Content-Type": "application/json",
                 "Authorization": f"{token_type} {access_token}",
-                "User-Agent": self._build_user_agent()
+                "User-Agent": self._build_user_agent(),
             },
             json={"refresh_token": refresh_token},
             timeout=self.default_timeout,

{cmsdials-1.7.0 → cmsdials-1.7.2}/cmsdials/clients/oms_proxy/client.py

@@ -1,7 +1,7 @@
 from typing import Optional
 
-import requests
 from requests.exceptions import HTTPError
+from requests.adapters import DEFAULT_RETRIES
 
 from ...auth._base import BaseCredentials
 from ...utils.api_client import BaseAPIClient
@@ -23,14 +23,13 @@ class OMSProxyClient(BaseAPIClient):
         self.creds = creds
 
     def _build_headers(self) -> dict:
-        base = {
-            "accept": "application/json",
-            "User-Agent": self._build_user_agent()
-        }
+        base = {"Accept": "application/json", "User-Agent": self._build_user_agent()}
         self.creds.before_request(base)
         return base
 
-    def query(self, endpoint: str, filters: list[OMSFilter], pages: Optional[list[OMSPage]] = None):
+    def query(
+        self, endpoint: str, filters: list[OMSFilter], pages: Optional[list[OMSPage]] = None, retries=DEFAULT_RETRIES
+    ):
         headers = self._build_headers()
         endpoint_url = self.api_url + self.lookup_url
 
@@ -39,7 +38,13 @@ class OMSProxyClient(BaseAPIClient):
         pages = {f"page[{page.attribute_name}]": page.value for page in pages} if pages and len(pages) > 0 else {}
         params = {"endpoint": endpoint, **filters, **pages}
 
-        response = requests.get(endpoint_url, headers=headers, params=params, timeout=self.default_timeout)
+        response = self._requests_get_retriable(
+            endpoint_url,
+            headers=headers,
+            params=params,
+            timeout=self.default_timeout,
+            retries=retries,
+        )
         try:
             response.raise_for_status()
         except HTTPError as err:

{cmsdials-1.7.0 → cmsdials-1.7.2}/cmsdials/utils/api_client.py

@@ -84,10 +84,7 @@ class BaseAuthorizedAPIClient(BaseAPIClient):
         self.workspace = workspace
 
     def _build_headers(self) -> dict:
-        base = {
-            "accept": "application/json",
-            "User-Agent": self._build_user_agent()
-        }
+        base = {"Accept": "application/json", "User-Agent": self._build_user_agent()}
         if self.workspace is not None:
             base["Workspace"] = self.workspace
         self.creds.before_request(base)