kroger-api 0.2.0__tar.gz → 0.3.1__tar.gz

{kroger_api-0.2.0 → kroger_api-0.3.1}/MANIFEST.in

@@ -7,8 +7,8 @@ include LICENSE
 # Include requirements
 include requirements.txt
 
-# Include assets (demo videos, images, etc.)
-recursive-include assets *.mp4 *.gif *.png *.jpg *.jpeg
+# Media assets stay on GitHub; don't ship them in the sdist
+recursive-exclude assets *
 
 # Include examples directory but don't package them in the main distribution
 recursive-include examples *.py

{kroger_api-0.2.0/kroger_api.egg-info → kroger_api-0.3.1}/PKG-INFO

@@ -1,9 +1,7 @@
 Metadata-Version: 2.4
 Name: kroger-api
-Version: 0.2.0
+Version: 0.3.1
 Summary: A Python client library for the Kroger Public API
-Home-page: https://github.com/CupOfOwls/kroger-api
-Author: Stephen Thoemmes
 Author-email: Stephen Thoemmes <thoemmes.stephen@gmail.com>
 License: MIT License
         
@@ -61,10 +59,7 @@ Requires-Dist: flake8; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Provides-Extra: examples
 Requires-Dist: tabulate>=0.8.0; extra == "examples"
-Dynamic: author
-Dynamic: home-page
 Dynamic: license-file
-Dynamic: requires-python
 
 # 🛒 Kroger Public API 🛍️  --  with Examples in Python 🐍
 
@@ -76,6 +71,8 @@ Adding an item to your cart via an interactive Python script, and checking that
 
 https://github.com/user-attachments/assets/0079cbc7-5af0-473b-909a-d43508fe43d5
 
+You can also check out [kroger-mcp](https://github.com/CupOfOwls/kroger-mcp), which is an implementation of the Model Context Protocol leveraging this kroger-api package!
+
 ## 🚀 Quick Start
 
 ### Installation
@@ -175,9 +172,15 @@ This library implements robust, automatic token management:
 2. On 401 Unauthorized errors, attempts token refresh
 3. Retries original request with new token
 
-Token files (automatically managed, stored in project root):
+Token files (automatically managed):
 - `.kroger_token_client_product.compact.json` - Client credentials tokens
 - `.kroger_token_user.json` - User authorization tokens
+These tokens are stored in the first matching location:
+1. `$KROGER_TOKEN_DIR` — set this environment variable to choose the directory yourself
+2. `$XDG_DATA_HOME/kroger-mcp/` (defaults to `~/.local/share/kroger-mcp/`) on Unix-like machines (macOS, Linux)
+3. `%APPDATA%\kroger-mcp\` on Windows
+
+The directory is shared with the [kroger-mcp](https://github.com/CupOfOwls/kroger-mcp) package so both reuse the same tokens, and it is always writable even when the process is launched with a read-only working directory (e.g. MCP servers under Claude Desktop on Windows).
 
 ### 🔒 Enhanced Security with PKCE
 

{kroger_api-0.2.0 → kroger_api-0.3.1}/README.md

@@ -8,6 +8,8 @@ Adding an item to your cart via an interactive Python script, and checking that
 
 https://github.com/user-attachments/assets/0079cbc7-5af0-473b-909a-d43508fe43d5
 
+You can also check out [kroger-mcp](https://github.com/CupOfOwls/kroger-mcp), which is an implementation of the Model Context Protocol leveraging this kroger-api package!
+
 ## 🚀 Quick Start
 
 ### Installation
@@ -107,9 +109,15 @@ This library implements robust, automatic token management:
 2. On 401 Unauthorized errors, attempts token refresh
 3. Retries original request with new token
 
-Token files (automatically managed, stored in project root):
+Token files (automatically managed):
 - `.kroger_token_client_product.compact.json` - Client credentials tokens
 - `.kroger_token_user.json` - User authorization tokens
+These tokens are stored in the first matching location:
+1. `$KROGER_TOKEN_DIR` — set this environment variable to choose the directory yourself
+2. `$XDG_DATA_HOME/kroger-mcp/` (defaults to `~/.local/share/kroger-mcp/`) on Unix-like machines (macOS, Linux)
+3. `%APPDATA%\kroger-mcp\` on Windows
+
+The directory is shared with the [kroger-mcp](https://github.com/CupOfOwls/kroger-mcp) package so both reuse the same tokens, and it is always writable even when the process is launched with a read-only working directory (e.g. MCP servers under Claude Desktop on Windows).
 
 ### 🔒 Enhanced Security with PKCE
 

{kroger_api-0.2.0 → kroger_api-0.3.1}/kroger_api/__init__.py

@@ -2,5 +2,6 @@
 from kroger_api.kroger_api import KrogerAPI
 from . import auth
 from . import utils
+from .client import KrogerClient
 
-__all__ = ['KrogerAPI', 'auth', 'utils']
+__all__ = ['KrogerAPI', 'auth', 'utils', 'KrogerClient']  # Optional but recommended

{kroger_api-0.2.0 → kroger_api-0.3.1}/kroger_api/api/authorization.py

@@ -1,3 +1,4 @@
+import sys
 from typing import Dict, Optional, Any
 
 from kroger_api.client import KrogerClient
@@ -7,7 +8,7 @@ from kroger_api.token_storage import get_refresh_token, load_token
 class AuthorizationAPI:
     """
     Provides access to the Kroger Authorization API endpoints.
-    """
+    """ 
     
     def __init__(self, client: KrogerClient):
         """
@@ -104,7 +105,7 @@ class AuthorizationAPI:
                 try:
                     return self.refresh_token(refresh_token)
                 except Exception as e:
-                    print(f"Failed to refresh token: {e}")
+                    print(f"Failed to refresh token: {e}", file=sys.stderr)
         
         # If we couldn't refresh or there was no token, return None
         return None

{kroger_api-0.2.0 → kroger_api-0.3.1}/kroger_api/client.py

@@ -1,3 +1,4 @@
+import sys
 import os
 import base64
 import requests
@@ -21,7 +22,7 @@ class KrogerClient:
     Base client for interacting with the Kroger API
     """
     BASE_URL = "https://api.kroger.com"
-    
+     
     def __init__(self, client_id: str = None, client_secret: str = None, redirect_uri: str = None):
         """
         Initialize the Kroger API client
@@ -91,7 +92,8 @@ class KrogerClient:
         Returns:
             The token information
         """
-        # Set the token file for this scope
+        # Set the token file for this scope (resolved to a writable
+        # directory by token_storage.get_token_file_path)
         self.token_file = f".kroger_token_client_{scope.replace(':', '_')}.json"
         
         # Try to load an existing token first
@@ -103,7 +105,7 @@ class KrogerClient:
                 return token_info
             
             # If token is invalid, get a new one
-            print("Token appears invalid, requesting a new one")
+            print("Token appears invalid, requesting a new one", file=sys.stderr)
             
         # If no valid token exists, get a new one
         token_info = self._get_token(grant_type="client_credentials", scope=scope)
@@ -174,7 +176,7 @@ class KrogerClient:
         except requests.exceptions.HTTPError as e:
             if e.response.status_code == 400:
                 # Invalid refresh token
-                print("Invalid refresh token. Please re-authenticate.")
+                print("Invalid refresh token. Please re-authenticate.", file=sys.stderr)
             raise
     
     def test_token(self, token_info: Dict[str, Any]) -> bool:
@@ -210,22 +212,22 @@ class KrogerClient:
                 
                 # If token is invalid and we have a refresh token, try to refresh
                 try:
-                    print("Token validation failed, attempting to refresh")
+                    print("Token validation failed, attempting to refresh", file=sys.stderr)
                     new_token_info = self.refresh_token(token_info["refresh_token"])
                     self.token_info = new_token_info
                     return True
                 except Exception as e:
-                    print(f"Failed to refresh token: {e}")
+                    print(f"Failed to refresh token: {e}", file=sys.stderr)
                     return False
             except Exception:
                 # If the validation request failed, try the refresh token
                 try:
-                    print("Token validation request failed, attempting to refresh")
+                    print("Token validation request failed, attempting to refresh", file=sys.stderr)
                     new_token_info = self.refresh_token(token_info["refresh_token"])
                     self.token_info = new_token_info
                     return True
                 except Exception as e:
-                    print(f"Failed to refresh token: {e}")
+                    print(f"Failed to refresh token: {e}", file=sys.stderr)
                     return False
         else:
             # If we don't have a refresh token, just validate the token directly
@@ -353,7 +355,7 @@ class KrogerClient:
                 
                 # Check if the error is due to an expired or invalid token
                 if error_data.get("error") == "invalid_token":
-                    print("Token is invalid or has expired, attempting to refresh")
+                    print("Token is invalid or has expired, attempting to refresh", file=sys.stderr)
                     
                     # Try to refresh the token if we have a refresh token
                     if self.token_file:
@@ -384,7 +386,7 @@ class KrogerClient:
                                     
                                 return response.json()
                             except Exception as refresh_error:
-                                print(f"Failed to refresh token: {refresh_error}")
+                                print(f"Failed to refresh token: {refresh_error}", file=sys.stderr)
                                 # Re-raise the original error if we couldn't refresh
                 
             # If we couldn't handle the error, re-raise it

kroger_api-0.3.1/kroger_api/tests/test_client.py

@@ -0,0 +1,36 @@
+import unittest
+from unittest.mock import patch, MagicMock
+from kroger_api.client import KrogerClient
+
+class TestKrogerClient(unittest.TestCase):
+
+    def setUp(self):
+        self.client = KrogerClient(client_id="fake_id", client_secret="fake_secret", redirect_uri="http://redirect.uri")
+
+    def test_get_authorization_url_basic(self):
+        url = self.client.get_authorization_url(scope="openid profile")
+        self.assertIn("scope=openid profile", url)
+        self.assertIn("client_id=fake_id", url)
+        self.assertIn("redirect_uri=http://redirect.uri", url)
+
+    @patch('kroger_api.client.load_token')
+    @patch('kroger_api.client.save_token')
+    @patch('kroger_api.client.requests.post')
+    
+    def test_get_token_with_client_credentials(self, mock_post, mock_save_token, mock_load_token):
+        #mock load_token to return None
+        mock_load_token.return_value = None
+        
+        #mock response from requests.post
+        mock_response = MagicMock()
+        mock_response.json.return_value = {"access_token": "abc123", "expires_in": 3600}
+        mock_response.raise_for_status = lambda: None
+        mock_post.return_value = mock_response
+        
+        token_info = self.client.get_token_with_client_credentials("scope1")
+        
+        self.assertEqual(token_info["access_token"], "abc123")
+        mock_save_token.assert_called_once()
+
+if __name__ == '__main__':
+    unittest.main()

{kroger_api-0.2.0 → kroger_api-0.3.1}/kroger_api/token_storage.py

@@ -3,13 +3,41 @@ Token storage utility for Kroger API client.
 This module provides functions to save and load OAuth tokens to avoid repeated logins.
 """
 
+import sys
 import os
 import json
+from pathlib import Path
 from typing import Dict, Any, Optional
 
 # Default token file location
 TOKEN_FILE = ".kroger_tokens.json"
 
+def get_token_file_path(token_name) -> str:
+    """Get the appropriate path for storing the token file.
+
+    Resolution order:
+      1. If token_name is already an absolute path, use it as-is.
+      2. If KROGER_TOKEN_DIR is set, store the file there.
+      3. Otherwise use the platform data directory (XDG spec on Unix,
+         APPDATA on Windows) under a 'kroger-mcp' subdirectory, which is
+         shared with the kroger-mcp package so both reuse the same tokens.
+    """
+    if os.path.isabs(token_name):
+        return token_name
+
+    env_dir = os.environ.get('KROGER_TOKEN_DIR')
+    if env_dir:
+        token_dir = Path(env_dir).expanduser()
+    elif os.name == 'nt': # Windows
+        token_dir = Path(os.environ.get('APPDATA', Path.home())) / 'kroger-mcp'
+    else: # Unix-like
+        token_dir = Path(os.environ.get('XDG_DATA_HOME', Path.home() / '.local' / 'share')) / 'kroger-mcp'
+
+    token_dir.mkdir(parents=True, exist_ok=True)
+    return str(token_dir / token_name)
+
+
+
 
 def save_token(token_info: Dict[str, Any], token_file: str = TOKEN_FILE) -> None:
     """
@@ -19,6 +47,10 @@ def save_token(token_info: Dict[str, Any], token_file: str = TOKEN_FILE) -> None
         token_info: The token information returned from the API
         token_file: The file path to save the token to
     """
+
+
+    token_file = get_token_file_path(token_file)
+
     # Save to file
     with open(token_file, "w") as f:
         json.dump(token_info, f, indent=2)
@@ -37,6 +69,9 @@ def load_token(token_file: str = TOKEN_FILE) -> Optional[Dict[str, Any]]:
     Returns:
         The token information or None if not available
     """
+
+    token_file = get_token_file_path(token_file)
+
     if not os.path.exists(token_file):
         return None
     
@@ -44,10 +79,10 @@ def load_token(token_file: str = TOKEN_FILE) -> Optional[Dict[str, Any]]:
         with open(token_file, "r") as f:
             token_info = json.load(f)
         
-        print(f"Found saved token, will test if it's still valid...")
+        print(f"Found saved token, will test if it's still valid...", file=sys.stderr)
         return token_info
     except (json.JSONDecodeError, IOError) as e:
-        print(f"Error loading token: {e}")
+        print(f"Error loading token: {e}", file=sys.stderr)
         return None
 
 
@@ -58,9 +93,13 @@ def clear_token(token_file: str = TOKEN_FILE) -> None:
     Args:
         token_file: The file path to delete
     """
+
+    token_file = get_token_file_path(token_file)
+
+
     if os.path.exists(token_file):
         os.remove(token_file)
-        print("Token file deleted.")
+        print("Token file deleted.", file=sys.stderr)
 
 
 def get_refresh_token(token_file: str = TOKEN_FILE) -> Optional[str]:
@@ -73,6 +112,9 @@ def get_refresh_token(token_file: str = TOKEN_FILE) -> Optional[str]:
     Returns:
         The refresh token or None if not available
     """
+
+    token_file = get_token_file_path(token_file)
+
     token_info = load_token(token_file)
     
     if token_info and "refresh_token" in token_info:

{kroger_api-0.2.0 → kroger_api-0.3.1}/kroger_api/utils/env.py

@@ -71,6 +71,6 @@ def get_zip_code(default: str = "00000") -> str:
     """
     zip_code = os.getenv("KROGER_USER_ZIP_CODE")
     if not zip_code:
-        print(f"KROGER_USER_ZIP_CODE environment variable is not set. Using default: {default}")
+        print(f"KROGER_USER_ZIP_CODE environment variable is not set. Using default: {default}", file=sys.stderr)
         return default
     return zip_code

{kroger_api-0.2.0 → kroger_api-0.3.1/kroger_api.egg-info}/PKG-INFO

@@ -1,9 +1,7 @@
 Metadata-Version: 2.4
 Name: kroger-api
-Version: 0.2.0
+Version: 0.3.1
 Summary: A Python client library for the Kroger Public API
-Home-page: https://github.com/CupOfOwls/kroger-api
-Author: Stephen Thoemmes
 Author-email: Stephen Thoemmes <thoemmes.stephen@gmail.com>
 License: MIT License
         
@@ -61,10 +59,7 @@ Requires-Dist: flake8; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Provides-Extra: examples
 Requires-Dist: tabulate>=0.8.0; extra == "examples"
-Dynamic: author
-Dynamic: home-page
 Dynamic: license-file
-Dynamic: requires-python
 
 # 🛒 Kroger Public API 🛍️  --  with Examples in Python 🐍
 
@@ -76,6 +71,8 @@ Adding an item to your cart via an interactive Python script, and checking that
 
 https://github.com/user-attachments/assets/0079cbc7-5af0-473b-909a-d43508fe43d5
 
+You can also check out [kroger-mcp](https://github.com/CupOfOwls/kroger-mcp), which is an implementation of the Model Context Protocol leveraging this kroger-api package!
+
 ## 🚀 Quick Start
 
 ### Installation
@@ -175,9 +172,15 @@ This library implements robust, automatic token management:
 2. On 401 Unauthorized errors, attempts token refresh
 3. Retries original request with new token
 
-Token files (automatically managed, stored in project root):
+Token files (automatically managed):
 - `.kroger_token_client_product.compact.json` - Client credentials tokens
 - `.kroger_token_user.json` - User authorization tokens
+These tokens are stored in the first matching location:
+1. `$KROGER_TOKEN_DIR` — set this environment variable to choose the directory yourself
+2. `$XDG_DATA_HOME/kroger-mcp/` (defaults to `~/.local/share/kroger-mcp/`) on Unix-like machines (macOS, Linux)
+3. `%APPDATA%\kroger-mcp\` on Windows
+
+The directory is shared with the [kroger-mcp](https://github.com/CupOfOwls/kroger-mcp) package so both reuse the same tokens, and it is always writable even when the process is launched with a read-only working directory (e.g. MCP servers under Claude Desktop on Windows).
 
 ### 🔒 Enhanced Security with PKCE
 

{kroger_api-0.2.0 → kroger_api-0.3.1}/kroger_api.egg-info/SOURCES.txt

@@ -1,12 +1,8 @@
-CHANGELOG.md
 LICENSE
 MANIFEST.in
 README.md
 pyproject.toml
 requirements.txt
-setup.py
-assets/kroger-api-python-add-to-cart-demo.mp4
-assets/product_api_script.gif
 examples/authorization_api_examples.py
 examples/cart_api_examples.py
 examples/clear_tokens.py
@@ -23,7 +19,6 @@ kroger_api/token_storage.py
 kroger_api.egg-info/PKG-INFO
 kroger_api.egg-info/SOURCES.txt
 kroger_api.egg-info/dependency_links.txt
-kroger_api.egg-info/not-zip-safe
 kroger_api.egg-info/requires.txt
 kroger_api.egg-info/top_level.txt
 kroger_api/api/__init__.py
@@ -34,6 +29,8 @@ kroger_api/api/location.py
 kroger_api/api/product.py
 kroger_api/auth/__init__.py
 kroger_api/auth/interactive.py
+kroger_api/tests/test_auth.py
+kroger_api/tests/test_client.py
 kroger_api/utils/__init__.py
 kroger_api/utils/env.py
 kroger_api/utils/oauth.py

{kroger_api-0.2.0 → kroger_api-0.3.1}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.2"]
+requires = ["setuptools>=61"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -33,7 +33,7 @@ dependencies = [
     "certifi>=2021.0.0",
     "urllib3>=1.26.0",
 ]
-dynamic = ["version"]
+version = "0.3.1"
 
 [project.optional-dependencies]
 dev = [
@@ -58,4 +58,3 @@ Documentation = "https://developer.kroger.com/documentation/public/"
 [tool.setuptools.packages.find]
 exclude = ["tests*", "docs_kroger_api*", "venv*", "examples*", "assets*"]
 
-[tool.setuptools_scm]

kroger_api-0.2.0/CHANGELOG.md

@@ -1,34 +0,0 @@
-# Changelog
-
-All notable changes to the `kroger-api` package will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [0.2.0] - 2025-05-28
-
-### Added
-
-- **PKCE Support**: Added Proof Key for Code Exchange (PKCE) support for enhanced security in the OAuth flow
-  - New `code_challenge` and `code_challenge_method` parameters in `get_authorization_url()`
-  - New `code_verifier` parameter in `get_token_with_authorization_code()`
-  - New utility module `pkce.py` with helper functions:
-    - `generate_code_verifier()`: Generate a random code verifier
-    - `generate_code_challenge()`: Generate a code challenge from a code verifier
-    - `generate_pkce_parameters()`: Generate all PKCE parameters in one call
-
-### Security
-
-- Enhanced OAuth security with PKCE support, mitigating authorization code interception attacks
-- Improved token exchange with better error handling for PKCE flows
-
-## [0.1.0] - 2025-05-23
-
-### Added
-
-- Initial release of the Kroger API client library
-- Support for OAuth 2.0 authorization code flow and client credentials flow
-- API access for products, locations, cart, identity, and more
-- Token storage and automatic refresh
-- Flexible token management with custom file paths
-- Example scripts for common use cases

kroger_api-0.2.0/kroger_api.egg-info/not-zip-safe

@@ -1 +0,0 @@
-

kroger_api-0.2.0/setup.py

@@ -1,75 +0,0 @@
-from setuptools import setup, find_packages
-import os
-
-# Read the contents of README file
-this_directory = os.path.abspath(os.path.dirname(__file__))
-with open(os.path.join(this_directory, 'README.md'), encoding='utf-8') as f:
-    long_description = f.read()
-
-setup(
-    name="kroger-api",
-    version="0.2.0",
-    packages=find_packages(exclude=['tests*', 'docs_kroger_api*', 'venv*', 'examples*', 'assets*']),
-    
-    # Dependencies
-    install_requires=[
-        "requests>=2.25.0",
-        "python-dotenv>=0.15.0",
-        "certifi>=2021.0.0",
-        "urllib3>=1.26.0",
-    ],
-    
-    # Optional dependencies for development/examples
-    extras_require={
-        'dev': [
-            'pytest>=7.0.0',
-            'pytest-mock>=3.0.0',
-            'requests-mock>=1.9.0',
-            'black',
-            'flake8',
-            'mypy',
-        ],
-        'examples': [
-            'tabulate>=0.8.0',
-        ],
-    },
-    
-    # Metadata
-    author="Stephen Thoemmes",
-    author_email="thoemmes.stephen@gmail.com",
-    description="A Python client library for the Kroger Public API",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    keywords="kroger, api, grocery, shopping, retail",
-    url="https://github.com/CupOfOwls/kroger-api",
-    project_urls={
-        "Bug Reports": "https://github.com/CupOfOwls/kroger-api/issues",
-        "Source": "https://github.com/CupOfOwls/kroger-api",
-        "Kroger API Documentation": "https://developer.kroger.com/documentation/public/",
-        "Demo Video": "https://github.com/CupOfOwls/kroger-api/blob/main/assets/kroger-api-python-add-to-cart-demo.mp4",
-    },
-    
-    # Classifiers for PyPI
-    classifiers=[
-        "Development Status :: 4 - Beta",
-        "Intended Audience :: Developers",
-        "License :: OSI Approved :: MIT License",
-        "Operating System :: OS Independent",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
-        "Programming Language :: Python :: 3.12",
-        "Topic :: Software Development :: Libraries :: Python Modules",
-        "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
-        "Topic :: Office/Business",
-    ],
-    
-    # Python version requirement
-    python_requires=">=3.8",
-    
-    # Include additional files (controlled by MANIFEST.in)
-    include_package_data=True,
-    zip_safe=False,
-)