hakai-api 2.0.0__tar.gz → 2.0.2__tar.gz

{hakai_api-2.0.0 → hakai_api-2.0.2}/.github/workflows/release.yaml

@@ -7,6 +7,8 @@ on:
     tags:
       - 'v[0-9]+.[0-9]+.[0-9]+'
       - 'v[0-9]+.[0-9]+.[0-9]+rc[0-9]+'
+    paths-ignore:
+      - 'README.md'
 
 jobs:
   publish:

{hakai_api-2.0.0 → hakai_api-2.0.2}/.github/workflows/test.yaml

@@ -24,11 +24,11 @@ jobs:
           - Windows
           - MacOs
         py:
+          - "3.15"
+          - "3.14"
           - "3.13"
           - "3.12"
           - "3.11"
-          - "3.10"
-          - "3.9"
     steps:
       - uses: actions/checkout@v4
       - name: Install uv

{hakai_api-2.0.0 → hakai_api-2.0.2}/PKG-INFO

@@ -1,12 +1,12 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: hakai_api
-Version: 2.0.0
+Version: 2.0.2
 Summary: Get Hakai database resources using http calls
 Author-email: Taylor Denouden <taylor.denouden@hakai.org>, Chris Davis <chris.davis@hakai.org>, Nate Rosenstock <nate.rosenstock@hakai.org>, Sam Albers <sam.albers@hakai.org>
 Maintainer-email: Taylor Denouden <taylor.denouden@hakai.org>, Sam Albers <sam.albers@hakai.org>
 License-Expression: MIT
 License-File: LICENSE
-Requires-Python: >=3.8
+Requires-Python: >=3.11
 Requires-Dist: loguru>=0.7.3
 Requires-Dist: pkce>=1.0.3
 Requires-Dist: pytz>=2025.2
@@ -22,7 +22,7 @@ The exported `Client` class extends the functionality of the
 Python [requests library](https://docs.python-requests.org/en/master/) to supply Hakai
 OAuth2 credentials with url requests.
 
-![PyPI](https://img.shields.io/pypi/v/hakai-api)   [![tests](https://github.com/HakaiInstitute/hakai-api-client-py/actions/workflows/test.yaml/badge.svg)](https://github.com/HakaiInstitute/hakai-api-client-py/actions/workflows/test.yaml)  [![License: MIT](https://img.shields.io/badge/License-MIT-black.svg)](https://opensource.org/licenses/MIT)
+[![PyPI](https://img.shields.io/pypi/v/hakai-api)](https://pypi.org/project/hakai_api/) [![tests](https://github.com/HakaiInstitute/hakai-api-client-py/actions/workflows/test.yaml/badge.svg)](https://github.com/HakaiInstitute/hakai-api-client-py/actions/workflows/test.yaml)  [![License: MIT](https://img.shields.io/badge/License-MIT-black.svg)](https://opensource.org/licenses/MIT)
 
 <details>
 
@@ -49,7 +49,7 @@ OAuth2 credentials with url requests.
 
 # Installation
 
-Python 3.8 or higher is required. Install with pip:
+Python 3.11 or higher is required. Install with pip:
 
 ```bash
 pip install hakai-api
@@ -102,6 +102,7 @@ client = Client(user_agent="MyApp/1.0 (contact@example.com)")
 # Or set via environment variable
 os.environ['HAKAI_API_USER_AGENT'] = "MyApp/1.0 (contact@example.com)"
 client = Client()
+```
 
 # Methods
 
@@ -126,7 +127,7 @@ from, see the [Hakai API documentation](https://github.com/HakaiInstitute/hakai-
 ## Custom API Endpoints
 
 You can specify which API to access when instantiating the Client. By default, the API
-uses `https://hecate.hakai.org/api` as the API root. It may be useful to use this
+uses `https://portal.hakai.org/api` as the API root. It may be useful to use this
 library to access a locally running API instance or to access the Goose API for testing
 purposes. If you are always going to be accessing data from a locally running API
 instance, you are better off using the requests.py library directly since Authorization
@@ -151,7 +152,7 @@ client = Client()
 
 # These are equivalent:
 response1 = client.get('/eims/views/output/stations')
-response2 = client.get('https://hecate.hakai.org/api/eims/views/output/stations')
+response2 = client.get('https://portal.hakai.org/api/eims/views/output/stations')
 ```
 
 ## Credentials Configuration

{hakai_api-2.0.0 → hakai_api-2.0.2}/README.md

@@ -6,7 +6,7 @@ The exported `Client` class extends the functionality of the
 Python [requests library](https://docs.python-requests.org/en/master/) to supply Hakai
 OAuth2 credentials with url requests.
 
-![PyPI](https://img.shields.io/pypi/v/hakai-api)   [![tests](https://github.com/HakaiInstitute/hakai-api-client-py/actions/workflows/test.yaml/badge.svg)](https://github.com/HakaiInstitute/hakai-api-client-py/actions/workflows/test.yaml)  [![License: MIT](https://img.shields.io/badge/License-MIT-black.svg)](https://opensource.org/licenses/MIT)
+[![PyPI](https://img.shields.io/pypi/v/hakai-api)](https://pypi.org/project/hakai_api/) [![tests](https://github.com/HakaiInstitute/hakai-api-client-py/actions/workflows/test.yaml/badge.svg)](https://github.com/HakaiInstitute/hakai-api-client-py/actions/workflows/test.yaml)  [![License: MIT](https://img.shields.io/badge/License-MIT-black.svg)](https://opensource.org/licenses/MIT)
 
 <details>
 
@@ -33,7 +33,7 @@ OAuth2 credentials with url requests.
 
 # Installation
 
-Python 3.8 or higher is required. Install with pip:
+Python 3.11 or higher is required. Install with pip:
 
 ```bash
 pip install hakai-api
@@ -86,6 +86,7 @@ client = Client(user_agent="MyApp/1.0 (contact@example.com)")
 # Or set via environment variable
 os.environ['HAKAI_API_USER_AGENT'] = "MyApp/1.0 (contact@example.com)"
 client = Client()
+```
 
 # Methods
 
@@ -110,7 +111,7 @@ from, see the [Hakai API documentation](https://github.com/HakaiInstitute/hakai-
 ## Custom API Endpoints
 
 You can specify which API to access when instantiating the Client. By default, the API
-uses `https://hecate.hakai.org/api` as the API root. It may be useful to use this
+uses `https://portal.hakai.org/api` as the API root. It may be useful to use this
 library to access a locally running API instance or to access the Goose API for testing
 purposes. If you are always going to be accessing data from a locally running API
 instance, you are better off using the requests.py library directly since Authorization
@@ -135,7 +136,7 @@ client = Client()
 
 # These are equivalent:
 response1 = client.get('/eims/views/output/stations')
-response2 = client.get('https://hecate.hakai.org/api/eims/views/output/stations')
+response2 = client.get('https://portal.hakai.org/api/eims/views/output/stations')
 ```
 
 ## Credentials Configuration

{hakai_api-2.0.0 → hakai_api-2.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hakai_api"
-version = "2.0.0"
+version = "2.0.2"
 description = "Get Hakai database resources using http calls"
 authors = [
     { name = "Taylor Denouden", email = "taylor.denouden@hakai.org" },
@@ -15,7 +15,7 @@ maintainers = [
 repository = "https://github.com/HakaiInstitute/hakai-api-client-py"
 license = "MIT"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.11"
 
 dependencies = [
     "loguru>=0.7.3",
@@ -75,7 +75,7 @@ convention = "google"
 combine-as-imports = true
 
 [tool.mypy]
-python_version = "3.10"
+python_version = "3.11"
 warn_return_any = false
 warn_unused_configs = true
 strict = true

{hakai_api-2.0.0 → hakai_api-2.0.2}/src/hakai_api/auth/base.py

@@ -45,7 +45,7 @@ class AuthStrategy(ABC):
     @property
     @abstractmethod
     def client_type(self) -> str:
-        """Get the client type for this authentication strategy.
+        """The client type for this authentication strategy.
 
         Returns:
             The client type string (e.g., 'web', 'desktop').

{hakai_api-2.0.0 → hakai_api-2.0.2}/src/hakai_api/auth/desktop.py

@@ -257,7 +257,7 @@ class DesktopAuthStrategy(AuthStrategy):
 
     @property
     def client_type(self) -> str:
-        """Get the client type for desktop authentication strategy."""
+        """The client type for the desktop authentication strategy."""
         return "desktop"
 
     # refresh_token method is now inherited from AuthStrategy base class

{hakai_api-2.0.0 → hakai_api-2.0.2}/src/hakai_api/auth/web.py

@@ -88,7 +88,7 @@ class WebAuthStrategy(AuthStrategy):
 
     @property
     def client_type(self) -> str:
-        """Get the client type for web authentication strategy."""
+        """The client type for the web authentication strategy."""
         return "web"
 
     # refresh_token method is now inherited from AuthStrategy base class

{hakai_api-2.0.0 → hakai_api-2.0.2}/src/hakai_api/client.py

@@ -52,8 +52,8 @@ class Client(OAuth2Session):
         >>> response = client.get("/custom/endpoint")
     """
 
-    DEFAULT_API_ROOT = "https://hecate.hakai.org/api"
-    DEFAULT_LOGIN_PAGE = "https://hecate.hakai.org/api-client-login"
+    DEFAULT_API_ROOT = "https://portal.hakai.org/api"
+    DEFAULT_LOGIN_PAGE = "https://portal.hakai.org/api-client-login"
     CREDENTIALS_ENV_VAR = "HAKAI_API_CREDENTIALS"
     USER_AGENT_ENV_VAR = "HAKAI_API_USER_AGENT"
 
@@ -151,7 +151,7 @@ class Client(OAuth2Session):
 
     @property
     def api_root(self) -> str:
-        """Return the api base url.
+        """The API base URL.
 
         Returns:
             The base URL of the Hakai API.
@@ -160,7 +160,7 @@ class Client(OAuth2Session):
 
     @property
     def login_page(self) -> str:
-        """Return the login page url.
+        """The login page URL.
 
         Returns:
             The URL of the login page.
@@ -169,7 +169,7 @@ class Client(OAuth2Session):
 
     @property
     def credentials(self) -> dict:
-        """Return the credentials object.
+        """The credentials object.
 
         Returns:
             Credentials object.

{hakai_api-2.0.0 → hakai_api-2.0.2}/tests/test_auth_strategies.py

@@ -3,10 +3,11 @@
 import json
 import os
 import tempfile
-from datetime import datetime, timezone
+from collections.abc import Generator
+from datetime import UTC, datetime
 from pathlib import Path
 from time import mktime
-from typing import Any, Generator
+from typing import Any
 from unittest.mock import Mock, patch
 
 import pytest
@@ -18,7 +19,7 @@ class ConcreteAuthStrategy(AuthStrategy):
     """Concrete implementation for testing the abstract base class."""
 
     def get_credentials(self) -> dict:
-        now_utc = datetime.now(timezone.utc)
+        now_utc = datetime.now(UTC)
         return {
             "access_token": "test_token",
             "token_type": "bearer",
@@ -58,7 +59,7 @@ def valid_credentials() -> dict:
     Returns:
         dict: Dictionary containing valid test credentials.
     """
-    now_utc = datetime.now(timezone.utc)
+    now_utc = datetime.now(UTC)
     future_timestamp = int(now_utc.timestamp() + 3600)  # Use UTC timestamp
     return {
         "access_token": "test_access_token",
@@ -75,7 +76,7 @@ def expired_credentials() -> dict:
     Returns:
         dict: Dictionary containing expired test credentials.
     """
-    now_utc = datetime.now(timezone.utc)
+    now_utc = datetime.now(UTC)
     past_timestamp = int(now_utc.timestamp() - 3600)  # Use UTC timestamp
     return {
         "access_token": "expired_access_token",
@@ -216,7 +217,7 @@ class TestWebAuthStrategy:
     def test_get_credentials_from_env(self) -> None:
         """Test getting credentials from environment variable."""
         # Use a future timestamp to ensure credentials aren't expired
-        future_timestamp = int(mktime(datetime.now(timezone.utc).timetuple()) + 3600)
+        future_timestamp = int(mktime(datetime.now(UTC).timetuple()) + 3600)
         env_value = f"access_token=env_token&token_type=bearer&expires_at={future_timestamp}&expires_in=3600"
 
         with patch.dict(os.environ, {"HAKAI_API_CREDENTIALS": env_value}):
@@ -303,7 +304,7 @@ class TestDesktopAuthStrategy:
     def test_get_credentials_from_env(self) -> None:
         """Test getting credentials from environment variable."""
         # Use a future timestamp to ensure credentials aren't expired
-        future_timestamp = int(mktime(datetime.now(timezone.utc).timetuple()) + 3600)
+        future_timestamp = int(mktime(datetime.now(UTC).timetuple()) + 3600)
         env_value = f"access_token=env_token&token_type=bearer&expires_at={future_timestamp}&expires_in=3600"
 
         with patch.dict(os.environ, {"HAKAI_API_CREDENTIALS": env_value}):

{hakai_api-2.0.0 → hakai_api-2.0.2}/tests/test_client.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import os
 import tempfile
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 from time import mktime
 from typing import Any, NoReturn
 from unittest.mock import Mock, patch
@@ -15,7 +15,7 @@ from hakai_api import Client
 def test_get_valid_credentials_from_file(temp_credentials_file):
     """Test that credentials can be read from a file."""
     # Create a client object with a temporary credentials file
-    now = datetime.now(timezone.utc)
+    now = datetime.now(UTC)
     client = Client(
         credentials={
             "token_type": "Bearer",
@@ -45,7 +45,7 @@ def test_get_valid_credentials_from_file(temp_credentials_file):
 def test_expired_credentials_are_handled(temp_credentials_file):
     """Test that expired credentials are removed properly."""
     # Create a client object with expired credentials and a temporary credentials file
-    now = datetime.now(timezone.utc)
+    now = datetime.now(UTC)
     client = Client(
         credentials={
             "token_type": "Bearer",
@@ -69,7 +69,7 @@ def test_expired_credentials_are_handled(temp_credentials_file):
 def test_custom_api_root(temp_credentials_file):
     """Test that a customized api root can be set."""
     # Create a client object with temporary credentials file
-    now = datetime.now(timezone.utc)
+    now = datetime.now(UTC)
     client = Client(
         credentials={
             "token_type": "Bearer",
@@ -88,7 +88,7 @@ def test_custom_api_root(temp_credentials_file):
 def test_custom_login_page(temp_credentials_file):
     """Test that a customized login page can be set."""
     # Create a client object with temporary credentials file
-    now = datetime.now(timezone.utc)
+    now = datetime.now(UTC)
     client = Client(
         credentials={
             "token_type": "Bearer",
@@ -107,7 +107,7 @@ def test_custom_login_page(temp_credentials_file):
 def test_credentials_from_env_variable(temp_credentials_file):
     """Test setting credentials with HAKAI_API_CREDENTIALS environment variable."""
     # Create a client object with temporary credentials file
-    now = datetime.now(timezone.utc)
+    now = datetime.now(UTC)
     os.environ["HAKAI_API_CREDENTIALS"] = "&".join([
         "token_type=Bearer",
         "access_token=test_access_token",
@@ -145,7 +145,7 @@ def test_user_agent_header(tmp_path):
         del os.environ[Client.USER_AGENT_ENV_VAR]
 
     # Create a client object with default User-Agent
-    now = datetime.now(timezone.utc)
+    now = datetime.now(UTC)
     client = Client(
         credentials={
             "token_type": "Bearer",
@@ -201,7 +201,7 @@ def temp_credentials_file():
 @pytest.fixture
 def valid_credentials():
     """Sample valid credentials for testing."""
-    future_timestamp = int(mktime(datetime.now(timezone.utc).timetuple()) + 3600)
+    future_timestamp = int(mktime(datetime.now(UTC).timetuple()) + 3600)
     return {
         "access_token": "valid_token",
         "token_type": "Bearer",
@@ -213,7 +213,7 @@ def valid_credentials():
 @pytest.fixture
 def expired_credentials():
     """Sample expired credentials for testing."""
-    now_utc = datetime.now(timezone.utc)
+    now_utc = datetime.now(UTC)
     past_timestamp = int(now_utc.timestamp() - 3600)  # Use UTC timestamp
     return {
         "access_token": "expired_token",
@@ -226,7 +226,7 @@ def expired_credentials():
 @pytest.fixture
 def credentials_with_refresh():
     """Sample credentials with refresh token."""
-    future_timestamp = int(mktime(datetime.now(timezone.utc).timetuple()) + 3600)
+    future_timestamp = int(mktime(datetime.now(UTC).timetuple()) + 3600)
     return {
         "access_token": "token_with_refresh",
         "token_type": "Bearer",
@@ -325,7 +325,7 @@ class TestClientCredentialScenarios:
             return {
                 "access_token": "new_token",
                 "token_type": "Bearer",
-                "expires_at": int(mktime(datetime.now(timezone.utc).timetuple()) + 3600),
+                "expires_at": int(mktime(datetime.now(UTC).timetuple()) + 3600),
                 "expires_in": 3600,
             }
 
@@ -367,7 +367,7 @@ class TestClientCredentialScenarios:
             return {
                 "access_token": "new_token",
                 "token_type": "Bearer",
-                "expires_at": int(mktime(datetime.now(timezone.utc).timetuple()) + 3600),
+                "expires_at": int(mktime(datetime.now(UTC).timetuple()) + 3600),
                 "expires_in": 3600,
             }
 
@@ -414,7 +414,7 @@ class TestClientCredentialScenarios:
     def test_expired_env_credentials_are_rejected(self, tmp_path):
         """Test that expired environment credentials are rejected."""
         # Set expired credentials in environment
-        now_utc = datetime.now(timezone.utc)
+        now_utc = datetime.now(UTC)
         past_timestamp = int(now_utc.timestamp() - 3600)  # Use UTC timestamp
         expired_env_creds = (
             f"access_token=expired_env_token&token_type=Bearer&expires_at={past_timestamp}&expires_in=3600"
@@ -473,7 +473,7 @@ class TestClientCredentialScenarios:
             return {
                 "access_token": "new_token",
                 "token_type": "Bearer",
-                "expires_at": int(mktime(datetime.now(timezone.utc).timetuple()) + 3600),
+                "expires_at": int(mktime(datetime.now(UTC).timetuple()) + 3600),
                 "expires_in": 3600,
             }
 
@@ -514,7 +514,7 @@ class TestClientRefreshTokenScenarios:
         credentials_with_refresh = {
             "access_token": "old_token",
             "token_type": "Bearer",
-            "expires_at": int(mktime(datetime.now(timezone.utc).timetuple()) + 3600),
+            "expires_at": int(mktime(datetime.now(UTC).timetuple()) + 3600),
             "expires_in": 3600,
             "refresh_token": "refresh123",
         }
@@ -524,7 +524,7 @@ class TestClientRefreshTokenScenarios:
             return {
                 "access_token": "refreshed_token",
                 "token_type": "Bearer",
-                "expires_at": int(mktime(datetime.now(timezone.utc).timetuple()) + 7200),
+                "expires_at": int(mktime(datetime.now(UTC).timetuple()) + 7200),
                 "expires_in": 7200,
                 "refresh_token": "refresh123",
             }
@@ -544,7 +544,7 @@ class TestClientRefreshTokenScenarios:
         credentials_with_refresh = {
             "access_token": "old_token",
             "token_type": "Bearer",
-            "expires_at": int(mktime(datetime.now(timezone.utc).timetuple()) + 3600),
+            "expires_at": int(mktime(datetime.now(UTC).timetuple()) + 3600),
             "expires_in": 3600,
             "refresh_token": "refresh123",
         }
@@ -554,7 +554,7 @@ class TestClientRefreshTokenScenarios:
             mock_response.status_code = 200
             mock_response.json.return_value = {
                 "access_token": "refreshed_web_token",
-                "expires_at": int(mktime(datetime.now(timezone.utc).timetuple()) + 7200),
+                "expires_at": int(mktime(datetime.now(UTC).timetuple()) + 7200),
                 "expires_in": 7200,
             }
             return mock_response
@@ -581,7 +581,7 @@ class TestClientRefreshTokenScenarios:
         credentials_with_refresh = {
             "access_token": "old_token",
             "token_type": "Bearer",
-            "expires_at": int(mktime(datetime.now(timezone.utc).timetuple()) + 3600),
+            "expires_at": int(mktime(datetime.now(UTC).timetuple()) + 3600),
             "expires_in": 3600,
             "refresh_token": "invalid_refresh",
         }