{"id":44742724,"url":"https://github.com/wexample/python-filestate","last_synced_at":"2026-02-15T21:14:27.252Z","repository":{"id":245062604,"uuid":"817245793","full_name":"wexample/python-filestate","owner":"wexample","description":null,"archived":false,"fork":false,"pushed_at":"2025-12-05T10:07:52.000Z","size":1105,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-06T13:54:24.880Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/wexample.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-06-19T10:04:42.000Z","updated_at":"2025-12-03T11:29:33.000Z","dependencies_parsed_at":"2024-06-19T13:29:37.700Z","dependency_job_id":"0898bcc9-27a9-49db-9e3b-d7d6d550623d","html_url":"https://github.com/wexample/python-filestate","commit_stats":null,"previous_names":["wexample/python-filestate"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/wexample/python-filestate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wexample%2Fpython-filestate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wexample%2Fpython-filestate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wexample%2Fpython-filestate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wexample%2Fpython-filestate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wexample","download_url":"https://codeload.github.com/wexample/python-filestate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wexample%2Fpython-filestate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29489704,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-15T19:29:10.908Z","status":"ssl_error","status_checked_at":"2026-02-15T19:29:10.419Z","response_time":118,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2026-02-15T21:14:26.598Z","updated_at":"2026-02-15T21:14:27.246Z","avatar_url":"https://github.com/wexample.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# wexample-filestate\n\nVersion: 0.0.74\n\nPackage that allows you to manage the state of files and directories using YAML configuration files.\n\n## Table of Contents\n\n- [Status Compatibility](#status-compatibility)\n- [Api Reference](#api-reference)\n- [Tests](#tests)\n- [Code Quality](#code-quality)\n- [Versioning](#versioning)\n- [Changelog](#changelog)\n- [Migration Notes](#migration-notes)\n- [Roadmap](#roadmap)\n- [Security](#security)\n- [Privacy](#privacy)\n- [Support](#support)\n- [Contribution Guidelines](#contribution-guidelines)\n- [Maintainers](#maintainers)\n- [License](#license)\n- [Useful Links](#useful-links)\n- [Suite Integration](#suite-integration)\n- [Compatibility Matrix](#compatibility-matrix)\n- [Dependencies](#dependencies)\n- [Suite Signature](#suite-signature)\n\n\n## Status \u0026 Compatibility\n\n**Maturity**: Production-ready\n\n**Python Support**: \u003e=3.10\n\n**OS Support**: Linux, macOS, Windows\n\n**Status**: Actively maintained\n\n## API Reference\n\nFull API documentation is available in the source code docstrings.\n\nKey modules and classes are documented with type hints for better IDE support.\n\n## Tests\n\nThis project uses `pytest` for testing and `pytest-cov` for code coverage analysis.\n\n### Installation\n\nFirst, install the required testing dependencies:\n```bash\n.venv/bin/python -m pip install pytest pytest-cov\n```\n\n### Basic Usage\n\nRun all tests with coverage:\n```bash\n.venv/bin/python -m pytest --cov --cov-report=html\n```\n\n### Common Commands\n```bash\n# Run tests with coverage for a specific module\n.venv/bin/python -m pytest --cov=your_module\n\n# Show which lines are not covered\n.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing\n\n# Generate an HTML coverage report\n.venv/bin/python -m pytest --cov=your_module --cov-report=html\n\n# Combine terminal and HTML reports\n.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html\n\n# Run specific test file with coverage\n.venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing\n```\n\n### Viewing HTML Reports\n\nAfter generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.\n\n### Coverage Threshold\n\nTo enforce a minimum coverage percentage:\n```bash\n.venv/bin/python -m pytest --cov=your_module --cov-fail-under=80\n```\n\nThis will cause the test suite to fail if coverage drops below 80%.\n\n## Code Quality \u0026 Typing\n\nAll the suite packages follow strict quality standards:\n\n- **Type hints**: Full type coverage with mypy validation\n- **Code formatting**: Enforced with black and isort\n- **Linting**: Comprehensive checks with custom scripts and tools\n- **Testing**: High test coverage requirements\n\nThese standards ensure reliability and maintainability across the suite.\n\n## Versioning \u0026 Compatibility Policy\n\nWexample packages follow **Semantic Versioning** (SemVer):\n\n- **MAJOR**: Breaking changes\n- **MINOR**: New features, backward compatible\n- **PATCH**: Bug fixes, backward compatible\n\nWe maintain backward compatibility within major versions and provide clear migration guides for breaking changes.\n\n## Changelog\n\nSee [CHANGELOG.md](CHANGELOG.md) for detailed version history and release notes.\n\nMajor changes are documented with migration guides when applicable.\n\n## Migration Notes\n\nWhen upgrading between major versions, refer to the migration guides in the documentation.\n\nBreaking changes are clearly documented with upgrade paths and examples.\n\n## Known Limitations \u0026 Roadmap\n\nCurrent limitations and planned features are tracked in the GitHub issues.\n\nSee the [project roadmap](https://github.com/wexample/python-filestate/issues) for upcoming features and improvements.\n\n## Security Policy\n\n### Reporting Vulnerabilities\n\nIf you discover a security vulnerability, please email contact@wexample.com.\n\n**Do not** open public issues for security vulnerabilities.\n\nWe take security seriously and will respond promptly to verified reports.\n\n## Privacy \u0026 Telemetry\n\nThis package does **not** collect any telemetry or usage data.\n\nYour privacy is respected — no data is transmitted to external services.\n\n## Support Channels\n\n- **GitHub Issues**: Bug reports and feature requests\n- **GitHub Discussions**: Questions and community support\n- **Documentation**: Comprehensive guides and API reference\n- **Email**: contact@wexample.com for general inquiries\n\nCommunity support is available through GitHub Discussions.\n\n## Contribution Guidelines\n\nWe welcome contributions to the Wexample suite!\n\n### How to Contribute\n\n1. **Fork** the repository\n2. **Create** a feature branch\n3. **Make** your changes\n4. **Test** thoroughly\n5. **Submit** a pull request\n\n## Maintainers \u0026 Authors\n\nMaintained by the Wexample team and community contributors.\n\nSee [CONTRIBUTORS.md](CONTRIBUTORS.md) for the full list of contributors.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\nFree to use in both personal and commercial projects.\n\n## Useful Links\n\n- **Homepage**: https://github.com/wexample/python-filestate\n- **Documentation**: [docs.wexample.com](https://docs.wexample.com)\n- **Issue Tracker**: https://github.com/wexample/python-filestate/issues\n- **Discussions**: https://github.com/wexample/python-filestate/discussions\n- **PyPI**: [pypi.org/project/wexample-filestate](https://pypi.org/project/wexample-filestate/)\n\n## Integration in the Suite\n\nThis package is part of the Wexample Suite — a collection of high-quality, modular tools designed to work seamlessly together across multiple languages and environments.\n\n### Related Packages\n\nThe suite includes packages for configuration management, file handling, prompts, and more. Each package can be used independently or as part of the integrated suite.\n\nVisit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.\n\n## Compatibility Matrix\n\nThis package is part of the Wexample suite and is compatible with other suite packages.\n\nRefer to each package's documentation for specific version compatibility requirements.\n\n## Dependencies\n\n- attrs: \u003e=23.1.0\n- cattrs: \u003e=23.1.0\n- jinja2: \n- python-dotenv: \n- tomlkit: \n- wexample-config: ==0.0.97\n- wexample-event: ==0.0.79\n- wexample-file: ==0.0.52\n- wexample-helpers-yaml: ==0.0.113\n- wexample-prompt: ==0.0.97\n- xmltodict: \n\n\n# About us\n\n[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.\n\nThis 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.\n\nWexample 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.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwexample%2Fpython-filestate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwexample%2Fpython-filestate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwexample%2Fpython-filestate/lists"}