cmsdials 1.7.0__tar.gz → 1.7.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cmsdials
-Version: 1.7.0
+Version: 1.7.1
 Summary: The Python api client interface to DIALS service
 Home-page: https://github.com/cms-DQM/dials-py
 Author: Gabriel Moreira
@@ -354,3 +354,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.0 → cmsdials-1.7.1}/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.1/cmsdials/_version.py

@@ -0,0 +1 @@
+__version__ = "1.7.1"

{cmsdials-1.7.0 → cmsdials-1.7.1}/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.1}/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
@@ -24,13 +24,13 @@ class OMSProxyClient(BaseAPIClient):
 
     def _build_headers(self) -> dict:
         base = {
-            "accept": "application/json",
+            "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 +39,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.1}/cmsdials/utils/api_client.py

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

{cmsdials-1.7.0 → cmsdials-1.7.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cmsdials"
-version = "1.7.0"
+version = "1.7.1"
 description = "The Python api client interface to DIALS service"
 authors = ["Gabriel Moreira <gabrielmscampos@gmail.com>"]
 readme = "README.md"

cmsdials-1.7.0/cmsdials/_version.py

@@ -1 +0,0 @@
-__version__ = "1.7.0"