{"id":28198946,"url":"https://github.com/undertone0809/conftier","last_synced_at":"2025-05-16T18:14:44.341Z","repository":{"id":285527688,"uuid":"957039122","full_name":"Undertone0809/conftier","owner":"Undertone0809","description":"A powerful Python multi-tier configuration management framework that simplifies the definition, access, and synchronization of layered configurations in Python application and framework.","archived":false,"fork":false,"pushed_at":"2025-05-16T10:37:26.000Z","size":900,"stargazers_count":20,"open_issues_count":15,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-16T11:19:41.661Z","etag":null,"topics":["dataclass","multi-level-config","pydantic","python","python-config","python-configuration"],"latest_commit_sha":null,"homepage":"http://conftier.zeeland.top/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Undertone0809.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-03-29T12:06:38.000Z","updated_at":"2025-05-15T01:16:17.000Z","dependencies_parsed_at":"2025-05-16T11:19:55.570Z","dependency_job_id":"3ffe429b-272e-4655-8e21-97e2465f66bd","html_url":"https://github.com/Undertone0809/conftier","commit_stats":null,"previous_names":["undertone0809/conftier"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Undertone0809%2Fconftier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Undertone0809%2Fconftier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Undertone0809%2Fconftier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Undertone0809%2Fconftier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Undertone0809","download_url":"https://codeload.github.com/Undertone0809/conftier/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254582932,"owners_count":22095520,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dataclass","multi-level-config","pydantic","python","python-config","python-configuration"],"created_at":"2025-05-16T18:14:22.237Z","updated_at":"2025-05-16T18:14:44.333Z","avatar_url":"https://github.com/Undertone0809.png","language":"Python","readme":"\u003cp align=\"center\"\u003e\n   \u003cimg src=\"./docs/public/banner.png\" alt=\"conftier Banner\" style=\"border-radius: 15px;\"\u003e\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![Build status](https://github.com/Undertone0809/conftier/workflows/build/badge.svg?branch=main\u0026event=push)](https://github.com/Undertone0809/conftier/actions?query=workflow%3Abuild)\n[![Python Version](https://img.shields.io/pypi/pyversions/conftier.svg)](https://pypi.org/project/conftier/)\n[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)\n[![License](https://img.shields.io/github/license/Undertone0809/conftier)](https://github.com/Undertone0809/conftier/blob/main/LICENSE)\n![Coverage Report](assets/images/coverage.svg)\n\n\u003c/div\u003e\n\n# Conftier\n\nA powerful multi-tier configuration management framework that simplifies the definition, access, and synchronization of layered configurations in Python applications.\n\nThink of VSCode's configuration system: you have user settings that apply globally and workspace settings that override them for specific projects. Conftier brings this same intuitive model to your Python frameworks and applications.\n\n## Documentation\n\nFor comprehensive guides, examples, and API reference, visit our documentation:\n\n- [Introduction](https://conftier.zeeland.top/)\n- [Quick Start Guide](https://conftier.zeeland.top/guide/quick-start.html)\n- [Contributing](https://conftier.zeeland.top/other/contributing.html)\n\n## Overview\n\nConftier helps you manage configurations across multiple levels:\n\n- **User-level settings**: Global preferences that apply across all projects (~/.zeeland/{config_name}/config.yaml)\n- **Project-level settings**: Local configurations specific to a project (./.{config_name}/config.yaml)\n- **Default values**: Fallback values defined in your configuration schema\n\nConftier automatically merges these configurations based on priority (project \u003e user \u003e default).\n\n\u003cp align=\"center\"\u003e\n   \u003cimg src=\"./docs/public/multi-config.png\" alt=\"conftier Banner\" style=\"border-radius: 15px;\"\u003e\n\u003c/p\u003e\n\n## Key Features\n\n- **Multi-level Configuration Management**: Like VSCode's user/workspace settings pattern\n- **Flexible Schema Definition**: Use Pydantic models or dataclasses to define and validate configurations\n- **Type Safety**: No more string/int confusion or missing required fields\n- **Smart Merging**: Only override what's specified, preserving other values\n- **CLI Integration**: Built-in command-line tools for configuration management\n- **IDE Autocompletion**: Full type hints for a great developer experience\n\n## Why Conftier?\n\n| Without Conftier | With Conftier |\n|------------------|---------------|\n| Manual parsing of multiple config files | Automatic loading and merging |\n| Type errors discovered at runtime | Validation at load time |\n| Custom code for merging configs | Smart merging built-in |\n| Documentation struggles | Schema serves as documentation |\n| Repetitive boilerplate | Consistent, reusable pattern |\n\n## Installation\n\n```bash\n# Basic installation\npip install conftier\n\n# With Pydantic support (recommended)\npip install conftier[pydantic]\n```\n\n## Quick Example\n\n```python\nfrom pydantic import BaseModel, Field\nfrom conftier import ConfigManager\n\nclass AppConfig(BaseModel):\n    app_name: str = \"MyApp\"\n    debug: bool = False\n\nconfig_manager = ConfigManager(\n    config_name=\"myapp\",\n    config_schema=AppConfig,\n    auto_create=True\n)\n\n# Load the merged configuration\nconfig: AppConfig = config_manager.load()\n```\n\n## When to Use Conftier\n\nConftier shines when:\n\n1. **You're building a framework or library**: Give your users a consistent way to configure your tool\n2. **Your app has both user and project settings**: Like VSCode's personal vs. project-specific settings\n3. **You need schema validation**: Ensure configuration values have the correct types and valid ranges\n4. **You want to reduce boilerplate**: Stop writing the same configuration loading code in every project\n\n## 🛡 License\n\n[![License](https://img.shields.io/github/license/Undertone0809/conftier)](https://github.com/Undertone0809/conftier/blob/main/LICENSE)\n\nThis project is licensed under the terms of the `MIT` license.\nSee [LICENSE](https://github.com/Undertone0809/conftier/blob/main/LICENSE) for more details.\n\n## 🤝 Support\n\nFor more information, please\ncontact: [zeeland4work@gmail.com](mailto:zeeland4work@gmail.com)\n\n## Credits [![🚀 Your next Python package needs a bleeding-edge project structure.](https://img.shields.io/badge/P3G-%F0%9F%9A%80-brightgreen)](https://github.com/Undertone0809/python-package-template)\n\nThis project was generated with [P3G](https://github.com/Undertone0809/P3G)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fundertone0809%2Fconftier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fundertone0809%2Fconftier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fundertone0809%2Fconftier/lists"}