day2 0.2.2__tar.gz → 0.2.3__tar.gz

{day2-0.2.2 → day2-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: day2
-Version: 0.2.2
+Version: 0.2.3
 Summary: MontyCloud DAY2 SDK for Python
 Author-email: MontyCloud <info@montycloud.com>
 Requires-Python: >=3.11
@@ -276,6 +276,52 @@ except Exception as e:
     print(f"Unexpected error: {e}")
 ```
 
+## Development
+
+### Documentation
+
+The project uses MkDocs for documentation. Here are the available commands:
+
+```bash
+# Build documentation locally
+make docs
+
+# Serve documentation for local development
+make serve-docs
+
+# Deploy documentation to GitHub Pages (from main branch)
+make deploy-docs
+
+# Deploy documentation from any branch to GitHub Pages
+make deploy-branch-docs
+```
+
+The `deploy-branch-docs` command is useful for:
+- Testing documentation changes before merging to main
+- Deploying documentation from feature branches
+- Creating documentation previews for pull requests
+
+**Note**: `deploy-branch-docs` will overwrite the current GitHub Pages content, so use with caution in production environments.
+
+### Other Development Commands
+
+```bash
+# Run tests
+make test
+
+# Run linting
+make lint
+
+# Format code
+make format
+
+# Run type checking
+make mypy
+
+# Run all CI checks
+make ci
+```
+
 ## License
 
 This project is licensed under the MIT License - see the LICENSE file for details.

{day2-0.2.2 → day2-0.2.3}/README.md

@@ -238,6 +238,52 @@ except Exception as e:
     print(f"Unexpected error: {e}")
 ```
 
+## Development
+
+### Documentation
+
+The project uses MkDocs for documentation. Here are the available commands:
+
+```bash
+# Build documentation locally
+make docs
+
+# Serve documentation for local development
+make serve-docs
+
+# Deploy documentation to GitHub Pages (from main branch)
+make deploy-docs
+
+# Deploy documentation from any branch to GitHub Pages
+make deploy-branch-docs
+```
+
+The `deploy-branch-docs` command is useful for:
+- Testing documentation changes before merging to main
+- Deploying documentation from feature branches
+- Creating documentation previews for pull requests
+
+**Note**: `deploy-branch-docs` will overwrite the current GitHub Pages content, so use with caution in production environments.
+
+### Other Development Commands
+
+```bash
+# Run tests
+make test
+
+# Run linting
+make lint
+
+# Format code
+make format
+
+# Run type checking
+make mypy
+
+# Run all CI checks
+make ci
+```
+
 ## License
 
 This project is licensed under the MIT License - see the LICENSE file for details.

day2-0.2.3/day2/auth/credentials.py

@@ -0,0 +1,400 @@
+"""Credential management for the MontyCloud SDK."""
+
+import configparser
+import os
+from pathlib import Path
+from typing import Optional
+
+
+class Credentials:
+    """Manages API keys and other authentication credentials."""
+
+    def __init__(
+        self,
+        api_key: Optional[str] = None,
+        api_secret_key: Optional[str] = None,
+        profile_name: Optional[str] = None,
+        base_url: Optional[str] = None,
+    ):
+        """Initialize credentials.
+
+        Args:
+            api_key: API key for authentication. If not provided, will attempt to load
+                from environment variables or configuration file.
+            api_secret_key: API secret key for authentication. If not provided, will attempt to load
+                from environment variables or configuration file.
+            profile_name: Profile name for credential section determination
+            base_url: Base URL for credential section determination
+        """
+        self.profile_name = profile_name
+        self.base_url = base_url
+
+        # Determine which credential section to use
+        self.credential_section = self._determine_credential_section(
+            profile_name, base_url
+        )
+
+        self.api_key = api_key or self._load_from_env() or self._load_from_config()
+        self.secret_key = (
+            api_secret_key
+            or self._load_api_secret_key_from_env()
+            or self._load_api_secret_key_from_config()
+        )
+
+        if not self.api_key:
+            raise ValueError(
+                "No API key provided. Please provide an API key via the constructor, "
+                "environment variable DAY2_API_KEY, or configuration file."
+            )
+
+    def _get_credentials_file_path(self) -> Path:
+        """Get the path to the credentials file.
+
+        Uses the same directory resolution logic as ProfileManager:
+        1. Check DAY2_CONFIG_PATH environment variable directory
+        2. Fall back to ~/.day2/ directory
+
+        Returns:
+            Path to the credentials file.
+        """
+        if os.environ.get("DAY2_CONFIG_PATH"):
+            config_file_path = Path(os.environ["DAY2_CONFIG_PATH"])
+            config_dir = config_file_path.parent
+        else:
+            config_dir = Path.home() / ".day2"
+
+        return config_dir / "credentials"
+
+    def _determine_credential_section(
+        self, profile_name: Optional[str], base_url: Optional[str]
+    ) -> str:
+        """Determine which credential section to use based on profile and base URL.
+
+        Args:
+            profile_name: Profile name
+            base_url: Base URL for the profile
+
+        Returns:
+            Credential section name to use ("DEFAULT" or profile name)
+        """
+        if not profile_name:
+            return "DEFAULT"
+
+        # Use smart detection to determine if we should use profile-specific credentials
+        if self._should_use_profile_credentials(base_url):
+            return profile_name
+        return "DEFAULT"
+
+    def _should_use_profile_credentials(self, base_url: Optional[str]) -> bool:
+        """Determine if a profile should use profile-specific credentials.
+
+        Logic:
+        - If base_url is different from the default base_url, use profile-specific credentials
+        - Otherwise, use shared credentials for the common MSP case
+
+        Args:
+            base_url: Base URL for this profile (or None to use default)
+
+        Returns:
+            True if profile should use profile-specific credentials, False for shared
+        """
+        # Default base URL
+        default_base_url = "https://api.montycloud.com/day2/api"
+
+        # If no base_url provided, use default
+        if not base_url:
+            base_url = default_base_url
+
+        # Check if this base_url differs from default (different region/environment)
+        if base_url != default_base_url:
+            return True
+
+        # Default to shared credentials for the common MSP case
+        return False
+
+    def _load_from_env(self) -> Optional[str]:
+        """Load API key from environment variables.
+
+        Returns:
+            API key if found in environment variables, None otherwise.
+        """
+        return os.environ.get("DAY2_API_KEY")
+
+    def _load_api_secret_key_from_env(self) -> Optional[str]:
+        """Load API secret key from environment variables.
+
+        Returns:
+            API secret key if found in environment variables, None otherwise.
+        """
+        return os.environ.get("DAY2_API_SECRET_KEY")
+
+    def _normalize_section_name(self, section_name: str) -> str:
+        """Normalize section name for consistent storage.
+
+        Args:
+            section_name: The section name to normalize
+
+        Returns:
+            Normalized section name (DEFAULT for default, original case for others)
+        """
+        if section_name.lower() == "default":
+            return "DEFAULT"
+        return section_name
+
+    def _find_section_case_insensitive(
+        self, config_parser: configparser.ConfigParser, section_name: str
+    ) -> Optional[str]:
+        """Find a section in the config parser, case-insensitively.
+
+        Args:
+            config_parser: The ConfigParser instance to search
+            section_name: The section name to find (case-insensitive)
+
+        Returns:
+            The actual section name if found, None otherwise.
+        """
+        # Check exact match first
+        if config_parser.has_section(section_name):
+            return section_name
+
+        # Check case-insensitive match
+        for actual_section in config_parser.sections():
+            if actual_section.lower() == section_name.lower():
+                return actual_section
+
+        # Special handling for DEFAULT section (configparser treats it specially)
+        if section_name.upper() == "DEFAULT":
+            # Check if DEFAULT exists in any case
+            if "DEFAULT" in config_parser:
+                return "DEFAULT"
+            for actual_section in config_parser.sections():
+                if actual_section.lower() == "default":
+                    return actual_section
+
+        return None
+
+    def _load_from_config(self) -> Optional[str]:
+        """Load API key from credentials file.
+
+        Returns:
+            API key if found in credentials file, None otherwise.
+        """
+        credentials_file = self._get_credentials_file_path()
+
+        if not credentials_file.exists():
+            return None
+
+        try:
+            config_parser = configparser.ConfigParser()
+            config_parser.read(credentials_file)
+
+            # Try to get from the determined section first (case-insensitive)
+            actual_section = self._find_section_case_insensitive(
+                config_parser, self.credential_section
+            )
+            if actual_section:
+                return config_parser.get(actual_section, "api_key", fallback=None)
+
+            # Fall back to DEFAULT section if profile section doesn't exist (case-insensitive)
+            default_section = self._find_section_case_insensitive(
+                config_parser, "DEFAULT"
+            )
+            if default_section:
+                return config_parser.get(default_section, "api_key", fallback=None)
+            return None
+        except (configparser.Error, IOError):
+            return None
+
+    def _load_api_secret_key_from_config(self) -> Optional[str]:
+        """Load API secret key from credentials file.
+
+        Returns:
+            API secret key if found in credentials file, None otherwise.
+        """
+        credentials_file = self._get_credentials_file_path()
+
+        if not credentials_file.exists():
+            return None
+
+        try:
+            config_parser = configparser.ConfigParser()
+            config_parser.read(credentials_file)
+
+            # Try to get from the determined section first (case-insensitive)
+            actual_section = self._find_section_case_insensitive(
+                config_parser, self.credential_section
+            )
+            if actual_section:
+                return config_parser.get(
+                    actual_section, "api_secret_key", fallback=None
+                )
+
+            # Fall back to DEFAULT section if profile section doesn't exist (case-insensitive)
+            default_section = self._find_section_case_insensitive(
+                config_parser, "DEFAULT"
+            )
+            if default_section:
+                return config_parser.get(
+                    default_section, "api_secret_key", fallback=None
+                )
+            return None
+        except (configparser.Error, IOError):
+            return None
+
+    def save_to_config(self, section_name: Optional[str] = None) -> None:
+        """Save credentials to credentials file.
+
+        Args:
+            section_name: Section name to save credentials to. If None, uses DEFAULT.
+        """
+        if not self.api_key:
+            return
+
+        config_dir = Path.home() / ".day2"
+        config_dir.mkdir(exist_ok=True)
+
+        credentials_file = config_dir / "credentials"
+
+        # Use provided section name or default to DEFAULT
+        target_section = self._normalize_section_name(section_name or "DEFAULT")
+
+        # Load existing credentials if they exist
+        config_parser = configparser.ConfigParser()
+        if credentials_file.exists():
+            config_parser.read(credentials_file)
+
+        # Handle case-insensitive section merging
+        self._merge_section_case_insensitive(config_parser, target_section)
+
+        # Update config with API key and secret
+        config_parser[target_section]["api_key"] = self.api_key
+        if self.secret_key:
+            config_parser[target_section]["api_secret_key"] = self.secret_key
+
+        # Save credentials
+        with open(credentials_file, "w", encoding="utf-8") as f:
+            config_parser.write(f)
+
+    def _merge_section_case_insensitive(
+        self, config_parser: configparser.ConfigParser, target_section: str
+    ) -> None:
+        """Merge existing section with different case into target section.
+
+        Args:
+            config_parser: The ConfigParser instance to modify
+            target_section: The normalized target section name
+        """
+        existing_section = self._find_section_case_insensitive(
+            config_parser, target_section
+        )
+
+        if existing_section and existing_section != target_section:
+            # Copy existing values to preserve them
+            existing_values = dict(config_parser[existing_section])
+            config_parser.remove_section(existing_section)
+            config_parser[target_section] = existing_values
+        elif not existing_section:
+            # Create new section
+            config_parser[target_section] = {}
+
+    @classmethod
+    def save_credentials_to_section(
+        cls,
+        api_key: str,
+        api_secret_key: Optional[str],
+        section_name: str,
+        credentials_file_path: Optional[Path] = None,
+    ) -> None:
+        """Save credentials to a specific section in the credentials file.
+
+        This is a utility method for auth.py to save credentials without creating a Credentials instance.
+
+        Args:
+            api_key: API key to save
+            api_secret_key: API secret key to save (optional)
+            section_name: Section name to save to
+            credentials_file_path: Optional custom path to credentials file
+        """
+        if credentials_file_path:
+            credentials_file = credentials_file_path
+            credentials_file.parent.mkdir(exist_ok=True)
+        else:
+            config_dir = Path.home() / ".day2"
+            config_dir.mkdir(exist_ok=True)
+            credentials_file = config_dir / "credentials"
+
+        # Normalize section name
+        normalized_section = cls.normalize_section_name(section_name)
+
+        # Load existing credentials
+        config_parser = configparser.ConfigParser()
+        if credentials_file.exists():
+            config_parser.read(credentials_file)
+
+        # Handle case-insensitive section merging
+        cls._merge_section_case_insensitive_static(config_parser, normalized_section)
+
+        # Update credentials
+        config_parser[normalized_section]["api_key"] = api_key or ""
+        if api_secret_key:
+            config_parser[normalized_section]["api_secret_key"] = api_secret_key
+
+        # Save credentials
+        with open(credentials_file, "w", encoding="utf-8") as f:
+            config_parser.write(f)
+
+    @staticmethod
+    def normalize_section_name(section_name: str) -> str:
+        """Normalize section name for consistent storage.
+
+        Args:
+            section_name: The section name to normalize
+
+        Returns:
+            Normalized section name (DEFAULT for default, original case for others)
+        """
+        if section_name.lower() == "default":
+            return "DEFAULT"
+        return section_name
+
+    @staticmethod
+    def _find_section_case_insensitive_static(
+        config_parser: configparser.ConfigParser, section_name: str
+    ) -> Optional[str]:
+        """Static version of _find_section_case_insensitive for class methods."""
+        # Check exact match first
+        if config_parser.has_section(section_name):
+            return section_name
+
+        # Check case-insensitive match
+        for actual_section in config_parser.sections():
+            if actual_section.lower() == section_name.lower():
+                return actual_section
+
+        # Special handling for DEFAULT section
+        if section_name.upper() == "DEFAULT":
+            if "DEFAULT" in config_parser:
+                return "DEFAULT"
+            for actual_section in config_parser.sections():
+                if actual_section.lower() == "default":
+                    return actual_section
+
+        return None
+
+    @staticmethod
+    def _merge_section_case_insensitive_static(
+        config_parser: configparser.ConfigParser, target_section: str
+    ) -> None:
+        """Static version of _merge_section_case_insensitive for class methods."""
+        existing_section = Credentials._find_section_case_insensitive_static(
+            config_parser, target_section
+        )
+
+        if existing_section and existing_section != target_section:
+            # Copy existing values to preserve them
+            existing_values = dict(config_parser[existing_section])
+            config_parser.remove_section(existing_section)
+            config_parser[target_section] = existing_values
+        elif not existing_section:
+            # Create new section
+            config_parser[target_section] = {}

{day2-0.2.2 → day2-0.2.3}/day2/client/base.py

@@ -73,6 +73,17 @@ class BaseClient:
             ),
         }
 
+        # Add User-Agent header
+        from day2._version import __version__
+
+        user_agent = f"day2-sdk/{__version__}"
+        if (
+            hasattr(self.session, "user_agent_suffix")
+            and self.session.user_agent_suffix
+        ):
+            user_agent += f" {self.session.user_agent_suffix}"
+        headers["User-Agent"] = user_agent
+
         # Add Authorization header if available
         # Use auth_token (which is actually the api_secret_key internally)
         if (

{day2-0.2.2 → day2-0.2.3}/day2/client/config.py

@@ -49,6 +49,9 @@ class Config:
     # CLI output format (table or json)
     output_format: str = "table"
 
+    # Profile name
+    profile: str = ""
+
     @property
     def api_url(self) -> str:
         """Get the full API URL.
@@ -74,6 +77,7 @@ class Config:
             "retry_min_delay": self.retry_min_delay,
             "retry_max_delay": self.retry_max_delay,
             "output_format": self.output_format,
+            "profile": self.profile,
         }
 
     @classmethod

day2-0.2.3/day2/client/constants.py

@@ -0,0 +1,23 @@
+"""Constants for the MontyCloud DAY2 SDK."""
+
+# Configuration constants
+DEFAULT_SECTION = "DEFAULT"
+PROFILE_PREFIX = "profile_"
+DEFAULT_PROFILE_KEY = "default_profile"
+CONFIG_DIR = ".day2"
+CONFIG_FILE = "config"
+
+# Environment variable keys
+ENV_PROFILE_KEY = "DAY2_PROFILE"
+
+# Configuration keys
+KEY_TENANT_ID = "tenant_id"
+KEY_BASE_URL = "base_url"
+KEY_API_VERSION = "api_version"
+KEY_TIMEOUT = "timeout"
+KEY_MAX_RETRIES = "max_retries"
+KEY_RETRY_BACKOFF = "retry_backoff_factor"
+KEY_RETRY_MIN_DELAY = "retry_min_delay"
+KEY_RETRY_MAX_DELAY = "retry_max_delay"
+KEY_OUTPUT_FORMAT = "output_format"
+KEY_PROFILE = "profile"