gpconfig 0.3.2__tar.gz

gpconfig-0.3.2/.github/workflows/docs.yml

@@ -0,0 +1,44 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - mkdocs_pre_publish
+    paths:
+      - docs/**
+      - mkdocs.yml
+      - .github/workflows/docs.yml
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install mkdocs-material mkdocs-static-i18n
+      - run: mkdocs build
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/deploy-pages@v5
+        id: deployment

gpconfig-0.3.2/.github/workflows/python-publish.yml

@@ -0,0 +1,71 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v5
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      url: https://pypi.org/project/gpconfig
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v5
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

gpconfig-0.3.2/.gitignore

@@ -0,0 +1,219 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+.vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Claude Code
+CLAUDE.md
+.claude/
+
+# OpenCode
+AGENTS.md
+.opencode/
+
+# User excluded
+draft/
+dev_docs/

gpconfig-0.3.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 LinnetCodes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

gpconfig-0.3.2/PKG-INFO

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: gpconfig
+Version: 0.3.2
+Summary: A type-safe, YAML-based configuration management library built on Pydantic
+Project-URL: Homepage, https://github.com/LinnetCodes/gpconfig
+Project-URL: Documentation, https://linnetcodes.github.io/gpconfig
+Project-URL: Repository, https://github.com/LinnetCodes/gpconfig
+Project-URL: Issues, https://github.com/LinnetCodes/gpconfig/issues
+Author-email: HAN Lin <lin_han@foxmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: config,configuration,pydantic,settings,type-safe,yaml
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: pydantic-settings>=2.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# gpconfig
+
+[简体中文](README.zh-CN.md) | English
+
+General Purpose Configuration management library for Python projects.
+
+A type-safe, YAML-based configuration management library built on Pydantic.
+
+## Features
+
+- **Type-safe configuration** - Built on Pydantic with full type validation
+- **YAML-based** - Human-readable configuration files
+- **Nested configs** - Organize configs in directories (e.g., `llm/openai.yaml`)
+- **Auto-detection** - Automatically detect config classes from YAML files
+- **Configurable objects** - Create object instances directly from configs
+- **Environment variable support** - Configure paths via environment variables
+- **Readonly configs** - Protect sensitive configurations
+
+## Installation
+
+```bash
+pip install gpconfig
+```
+
+## Quick Start
+
+### 1. Define Config Classes
+
+```python
+from typing import ClassVar
+from gpconfig import GPConfig
+
+class DatabaseConfig(GPConfig):
+    cfg_class_name: ClassVar[str] = "DatabaseConfig"
+    host: str
+    port: int = 5432
+    username: str
+    password: str
+    database: str
+```
+
+### 2. Create Config Folder
+
+```
+myapp/
+├── global_env.yaml    # Required: global environment config
+├── database.yaml      # Your config files
+└── llm/               # Nested configs
+    ├── openai.yaml
+    └── anthropic.yaml
+```
+
+**global_env.yaml:**
+```yaml
+version: "1.0.0"
+debug: true
+log_level: INFO
+```
+
+**database.yaml:**
+```yaml
+cfg_class_name: "DatabaseConfig"
+host: localhost
+port: 5432
+username: admin
+password: secret
+database: myapp
+```
+
+### 3. Initialize Manager and Load Configs
+
+```python
+from gpconfig import GPConfigManager
+
+# Config folder search order:
+# 1. Explicit cfg_folder parameter
+# 2. Environment variable: {PROJECT_NAME}_CFG_PATH
+# 3. User directory: ~/.{project_name}/
+manager = GPConfigManager("myapp", cfg_folder="/path/to/myapp")
+
+# Read global_env values
+debug = manager.get_config("global_env.debug")
+
+# Load config (auto-detect class by cfg_class_name)
+db_config = manager.get_config("database")
+
+# Load nested config
+llm_config = manager.get_config("llm.openai")
+
+# Read specific field
+host = manager.get_config("database.host")
+```
+
+### 4. Create Configurable Objects
+
+```python
+from gpconfig import GPConfigurable
+
+class Database(GPConfigurable):
+    def __init__(self, config: DatabaseConfig) -> None:
+        super().__init__(config)
+        self.host = config.host
+        self.port = config.port
+        self.username = config.username
+        self.password = config.password
+        self.database = config.database
+
+    @property
+    def connection_string(self) -> str:
+        return f"postgresql://{self.username}:{self.password}@{self.host}:{self.port}/{self.database}"
+
+# Register classes
+GPConfigManager.register_config_class(DatabaseConfig)
+GPConfigManager.register_configurable_class(Database)
+
+# Create object instance
+db = manager.get_object("database")
+print(db.connection_string)
+```
+
+**Note:** Add `configured_class_name` to your YAML for `get_object()`:
+
+```yaml
+cfg_class_name: "DatabaseConfig"
+configured_class_name: "Database"
+host: localhost
+port: 5432
+```
+
+### 5. Save Configs
+
+```python
+# Modify and save
+db_config.port = 5433
+db_config.save()
+
+# Save to new location
+manager.save(db_config, "backups/database_backup")
+```
+
+## Core Components
+
+| Component | Description |
+|-----------|-------------|
+| `GPConfig` | Base class for all config classes |
+| `GPConfigurable` | Base class for objects created from configs |
+| `GPConfigManager` | Manages config folder, loading, and object creation |
+
+## Exceptions
+
+| Exception | Description |
+|-----------|-------------|
+| `GPConfigError` | Base exception for all gpconfig errors |
+| `ConfigFolderError` | Config folder not found or invalid |
+| `ConfigNotFoundError` | Requested config path does not exist |
+| `ConfigReadonlyError` | Attempted to modify readonly config |
+| `RegistrationError` | Class registration issues |
+| `ConfigValidationError` | Config file validation failed |
+
+## API Reference
+
+See the [API documentation](docs/api/en/index.md) for detailed usage.
+
+## License
+
+MIT