Migrate configuration from YAML to Pydantic-settings

Replace the YAML-based settings.yaml configuration with a modern
Pydantic-settings approach using environment variables.

Changes:
- Add pydantic-settings>=2.0 dependency
- Create gerritclient/settings.py with GerritSettings model
- Update client.py to import get_settings from new module
- Delete legacy settings.yaml file
- Add .env.example template for configuration
- Update .gitignore to exclude .env files
- Add comprehensive test suite for settings (18 tests)
- Update documentation with environment variable configuration

Configuration is now loaded from:
1. Environment variables (GERRIT_URL, GERRIT_AUTH_TYPE, etc.)
2. .env file in current directory

This is a breaking change - users must migrate from settings.yaml
to environment variables or .env files.

Author: tivaliy

.coverage

@@ -0,0 +1,22 @@
+# Gerrit Client Configuration
+# Copy this file to .env and customize with your settings
+#
+# Configuration is loaded from environment variables with GERRIT_ prefix.
+# You can either:
+#   1. Set environment variables directly: export GERRIT_URL=https://...
+#   2. Create a .env file (copy this template)
+
+# Gerrit server URL (required)
+# Example: https://review.openstack.org or http://localhost:8080
+GERRIT_URL=https://review.example.com
+
+# Authentication type (optional)
+# Valid values: basic, digest
+# Omit or leave empty for anonymous access
+GERRIT_AUTH_TYPE=basic
+
+# Credentials (required if GERRIT_AUTH_TYPE is set)
+# Username: Your Gerrit account username
+# Password: HTTP password from Gerrit (Settings -> HTTP Credentials)
+GERRIT_USERNAME=your-username
+GERRIT_PASSWORD=your-http-password

.env.example

@@ -9,3 +9,6 @@
 docs/build
 /dist/
 /build/
+
+# Environment configuration (contains secrets)
+.env

.gitignore

@@ -46,6 +46,33 @@ Using pip::
 
     pip install python-gerritclient
 
+Configuration
+~~~~~~~~~~~~~
+
+Configuration is loaded from environment variables with the ``GERRIT_`` prefix.
+
+**Using environment variables** (recommended for CI/CD)::
+
+    export GERRIT_URL=https://review.example.com
+    export GERRIT_AUTH_TYPE=basic
+    export GERRIT_USERNAME=your-username
+    export GERRIT_PASSWORD=your-http-password
+
+**Using a .env file** (recommended for local development)::
+
+    # Create a .env file in your project directory
+    GERRIT_URL=https://review.example.com
+    GERRIT_AUTH_TYPE=basic
+    GERRIT_USERNAME=your-username
+    GERRIT_PASSWORD=your-http-password
+
+**Configuration options:**
+
+* ``GERRIT_URL`` (required): Gerrit server URL (e.g., ``https://review.openstack.org``)
+* ``GERRIT_AUTH_TYPE`` (optional): Authentication type - ``basic`` or ``digest``. Omit for anonymous access.
+* ``GERRIT_USERNAME`` (required if auth_type set): Your Gerrit username
+* ``GERRIT_PASSWORD`` (required if auth_type set): HTTP password from Gerrit (Settings -> HTTP Credentials)
+
 Basic Usage
 ~~~~~~~~~~~
 
@@ -59,13 +86,17 @@ Python API::
 
     from gerritclient import client
 
+    # Option 1: Use environment variables (automatic)
+    group_client = client.get_client('group')
+    members = group_client.get_group_members('core-team')
+
+    # Option 2: Explicit connection
     connection = client.connect(
-        "review.example.com",
+        "https://review.example.com",
         auth_type="digest",
         username="user",
         password="pass"
     )
-
     group_client = client.get_client('group', connection=connection)
     members = group_client.get_group_members('core-team')
 

docs/source/index.rst

@@ -14,14 +14,14 @@
 #    under the License.
 
 import json
-import os
 
 import requests
 from requests import auth
 
 import gerritclient
 from gerritclient import error
 from gerritclient.common import utils
+from gerritclient.settings import get_settings
 
 
 class APIClient:
@@ -177,42 +177,6 @@ def _decode_content(response):
         return json.loads(response.text.strip(")]}'"))
 
 
-def get_settings(file_path=None):
-    """Gets gerritclient configuration from 'settings.yaml' file.
-
-    If path to configuration 'settings.yaml' file not specified (None), then
-    first try to get it from local directory and then from user .config one
-
-    :param str file_path: string that contains path to configuration file
-    :raises: error.ConfigNotFoundException if configuration not specified
-    """
-
-    config = None
-
-    user_config = os.path.join(
-        os.path.expanduser("~"), ".config", "gerritclient", "settings.yaml"
-    )
-    local_config = os.path.join(os.path.dirname(__file__), "settings.yaml")
-
-    if file_path is not None:
-        config = file_path
-    else:
-        if os.path.isfile(local_config):
-            config = local_config
-        elif os.path.isfile(user_config):
-            config = user_config
-
-    if config is None:
-        raise error.ConfigNotFoundException("Configuration not found.")
-
-    try:
-        config_data = utils.read_from_file(config)
-    except OSError:
-        msg = f"Could not read settings from {file_path}"
-        raise error.InvalidFileException(msg)
-    return config_data
-
-
 def connect(url, auth_type=None, username=None, password=None):
     """Creates API connection."""
 

gerritclient/client.py

@@ -0,0 +1,105 @@
+#
+#    Copyright 2017 Vitalii Kulanov
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+"""Pydantic-based settings management for gerritclient.
+
+Configuration is loaded from environment variables with the GERRIT_ prefix.
+A .env file in the current directory is also supported.
+
+Environment variables:
+    GERRIT_URL: Gerrit server URL (required)
+    GERRIT_AUTH_TYPE: Authentication type - 'basic' or 'digest' (optional)
+    GERRIT_USERNAME: Username for authentication (required if auth_type set)
+    GERRIT_PASSWORD: HTTP password for authentication (required if auth_type set)
+
+Example .env file:
+    GERRIT_URL=https://review.example.com
+    GERRIT_AUTH_TYPE=basic
+    GERRIT_USERNAME=admin
+    GERRIT_PASSWORD=secret
+"""
+
+from typing import Literal
+
+from pydantic import Field, field_validator, model_validator
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class GerritSettings(BaseSettings):
+    """Gerrit client configuration with validation.
+
+    Configuration sources (highest to lowest priority):
+    1. Explicit keyword arguments
+    2. Environment variables (GERRIT_URL, GERRIT_AUTH_TYPE, etc.)
+    3. .env file in current directory
+    """
+
+    model_config = SettingsConfigDict(
+        env_prefix="GERRIT_",
+        env_file=".env",
+        env_file_encoding="utf-8",
+        extra="ignore",
+    )
+
+    url: str = Field(
+        ..., description="Gerrit server URL (e.g., https://review.example.com)"
+    )
+    auth_type: Literal["basic", "digest"] | None = Field(
+        default=None,
+        description="HTTP authentication scheme. Omit for anonymous access.",
+    )
+    username: str | None = Field(default=None, description="Gerrit username")
+    password: str | None = Field(default=None, description="Gerrit HTTP password")
+
+    @field_validator("url")
+    @classmethod
+    def validate_url(cls, v: str) -> str:
+        """Validate and normalize the Gerrit server URL."""
+        if not v.startswith(("http://", "https://")):
+            raise ValueError("URL must start with http:// or https://")
+        return v.rstrip("/")
+
+    @model_validator(mode="after")
+    def validate_auth_credentials(self) -> "GerritSettings":
+        """Ensure username and password are provided when auth_type is set."""
+        if self.auth_type and not all([self.username, self.password]):
+            raise ValueError("username and password are required when auth_type is set")
+        return self
+
+    def to_dict(self) -> dict:
+        """Convert settings to dict compatible with client.connect()."""
+        return {
+            "url": self.url,
+            "auth_type": self.auth_type,
+            "username": self.username,
+            "password": self.password,
+        }
+
+
+def get_settings() -> dict:
+    """Load gerritclient configuration.
+
+    Configuration sources (highest to lowest priority):
+    1. Environment variables (GERRIT_URL, GERRIT_AUTH_TYPE, etc.)
+    2. .env file in current directory
+
+    Returns:
+        Configuration dictionary compatible with connect()
+
+    Raises:
+        pydantic.ValidationError: If configuration is invalid or missing
+    """
+    settings = GerritSettings()
+    return settings.to_dict()