https://github.com/wexample/python-config
https://github.com/wexample/python-config
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/wexample/python-config
- Owner: wexample
- Created: 2024-10-31T09:08:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-12-03T12:08:26.000Z (4 months ago)
- Last Synced: 2025-12-06T13:50:59.532Z (4 months ago)
- Language: Python
- Size: 297 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# wexample-config
Version: 0.0.97
Helpers to manage dict types configurations.
## Table of Contents
- [Status Compatibility](#status-compatibility)
- [Api Reference](#api-reference)
- [Tests](#tests)
- [Code Quality](#code-quality)
- [Versioning](#versioning)
- [Changelog](#changelog)
- [Migration Notes](#migration-notes)
- [Roadmap](#roadmap)
- [Security](#security)
- [Privacy](#privacy)
- [Support](#support)
- [Contribution Guidelines](#contribution-guidelines)
- [Maintainers](#maintainers)
- [License](#license)
- [Useful Links](#useful-links)
- [Suite Integration](#suite-integration)
- [Compatibility Matrix](#compatibility-matrix)
- [Dependencies](#dependencies)
- [Suite Signature](#suite-signature)
## Status & Compatibility
**Maturity**: Production-ready
**Python Support**: >=3.10
**OS Support**: Linux, macOS, Windows
**Status**: Actively maintained
## API Reference
Full API documentation is available in the source code docstrings.
Key modules and classes are documented with type hints for better IDE support.
## Tests
This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
### Installation
First, install the required testing dependencies:
```bash
.venv/bin/python -m pip install pytest pytest-cov
```
### Basic Usage
Run all tests with coverage:
```bash
.venv/bin/python -m pytest --cov --cov-report=html
```
### Common Commands
```bash
# Run tests with coverage for a specific module
.venv/bin/python -m pytest --cov=your_module
# Show which lines are not covered
.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
# Generate an HTML coverage report
.venv/bin/python -m pytest --cov=your_module --cov-report=html
# Combine terminal and HTML reports
.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
# Run specific test file with coverage
.venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
```
### Viewing HTML Reports
After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
### Coverage Threshold
To enforce a minimum coverage percentage:
```bash
.venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
```
This will cause the test suite to fail if coverage drops below 80%.
## Code Quality & Typing
All the suite packages follow strict quality standards:
- **Type hints**: Full type coverage with mypy validation
- **Code formatting**: Enforced with black and isort
- **Linting**: Comprehensive checks with custom scripts and tools
- **Testing**: High test coverage requirements
These standards ensure reliability and maintainability across the suite.
## Versioning & Compatibility Policy
Wexample packages follow **Semantic Versioning** (SemVer):
- **MAJOR**: Breaking changes
- **MINOR**: New features, backward compatible
- **PATCH**: Bug fixes, backward compatible
We maintain backward compatibility within major versions and provide clear migration guides for breaking changes.
## Changelog
See [CHANGELOG.md](CHANGELOG.md) for detailed version history and release notes.
Major changes are documented with migration guides when applicable.
## Migration Notes
When upgrading between major versions, refer to the migration guides in the documentation.
Breaking changes are clearly documented with upgrade paths and examples.
## Known Limitations & Roadmap
Current limitations and planned features are tracked in the GitHub issues.
See the [project roadmap](https://github.com/wexample/python-config/issues) for upcoming features and improvements.
## Security Policy
### Reporting Vulnerabilities
If you discover a security vulnerability, please email contact@wexample.com.
**Do not** open public issues for security vulnerabilities.
We take security seriously and will respond promptly to verified reports.
## Privacy & Telemetry
This package does **not** collect any telemetry or usage data.
Your privacy is respected — no data is transmitted to external services.
## Support Channels
- **GitHub Issues**: Bug reports and feature requests
- **GitHub Discussions**: Questions and community support
- **Documentation**: Comprehensive guides and API reference
- **Email**: contact@wexample.com for general inquiries
Community support is available through GitHub Discussions.
## Contribution Guidelines
We welcome contributions to the Wexample suite!
### How to Contribute
1. **Fork** the repository
2. **Create** a feature branch
3. **Make** your changes
4. **Test** thoroughly
5. **Submit** a pull request
## Maintainers & Authors
Maintained by the Wexample team and community contributors.
See [CONTRIBUTORS.md](CONTRIBUTORS.md) for the full list of contributors.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Free to use in both personal and commercial projects.
## Useful Links
- **Homepage**: https://github.com/wexample/python-config
- **Documentation**: [docs.wexample.com](https://docs.wexample.com)
- **Issue Tracker**: https://github.com/wexample/python-config/issues
- **Discussions**: https://github.com/wexample/python-config/discussions
- **PyPI**: [pypi.org/project/wexample-config](https://pypi.org/project/wexample-config/)
## Integration in the Suite
This package is part of the Wexample Suite — a collection of high-quality, modular tools designed to work seamlessly together across multiple languages and environments.
### Related Packages
The suite includes packages for configuration management, file handling, prompts, and more. Each package can be used independently or as part of the integrated suite.
Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
## Compatibility Matrix
This package is part of the Wexample suite and is compatible with other suite packages.
Refer to each package's documentation for specific version compatibility requirements.
## Dependencies
- attrs: >=23.1.0
- cattrs: >=23.1.0
- pydantic: <3,>=2
- wexample-helpers: ==0.0.88
# About us
[Wexample](https://wexample.com) stands as a cornerstone of the digital ecosystem — a collective of seasoned engineers, researchers, and creators driven by a relentless pursuit of technological excellence. More than a media platform, it has grown into a vibrant community where innovation meets craftsmanship, and where every line of code reflects a commitment to clarity, durability, and shared intelligence.
This packages suite embodies this spirit. Trusted by professionals and enthusiasts alike, it delivers a consistent, high-quality foundation for modern development — open, elegant, and battle-tested. Its reputation is built on years of collaboration, refinement, and rigorous attention to detail, making it a natural choice for those who demand both robustness and beauty in their tools.
Wexample cultivates a culture of mastery. Each package, each contribution carries the mark of a community that values precision, ethics, and innovation — a community proud to shape the future of digital craftsmanship.