wexample-filestate-dev 0.0.48__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. wexample_filestate_dev-0.0.48/PKG-INFO +186 -0
  2. wexample_filestate_dev-0.0.48/README.md +167 -0
  3. wexample_filestate_dev-0.0.48/pyproject.toml +86 -0
  4. wexample_filestate_dev-0.0.48/src/wexample_filestate_dev/__init__.py +0 -0
  5. wexample_filestate_dev-0.0.48/src/wexample_filestate_dev/exception/__init__.py +0 -0
  6. wexample_filestate_dev-0.0.48/src/wexample_filestate_dev/helpers/__init__.py +0 -0
  7. wexample_filestate_dev-0.0.48/src/wexample_filestate_dev/py.typed +0 -0
  8. wexample_filestate_dev-0.0.48/src/wexample_filestate_dev/workdir/__init__.py +0 -0
wexample_filestate_dev-0.0.48/PKG-INFO ADDED
@@ -0,0 +1,186 @@
1
+ Metadata-Version: 2.1
2
+ Name: wexample-filestate-dev
3
+ Version: 0.0.48
4
+ Summary: Some python basic helpers.
5
+ Author-Email: weeger <contact@wexample.com>
6
+ License: MIT
7
+ Classifier: Programming Language :: Python :: 3
8
+ Classifier: License :: OSI Approved :: MIT License
9
+ Classifier: Operating System :: OS Independent
10
+ Project-URL: homepage, https://github.com/wexample/python-filestate-dev
11
+ Requires-Python: >=3.10
12
+ Requires-Dist: attrs>=23.1.0
13
+ Requires-Dist: cattrs>=23.1.0
14
+ Requires-Dist: wexample-filestate==0.0.71
15
+ Provides-Extra: dev
16
+ Requires-Dist: pytest; extra == "dev"
17
+ Requires-Dist: pytest-cov; extra == "dev"
18
+ Description-Content-Type: text/markdown
19
+
20
+ # wexample-filestate-dev
21
+
22
+ Version: 0.0.48
23
+
24
+ Some python basic helpers.
25
+
26
+ ## Tests
27
+
28
+ This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
29
+
30
+ ### Installation
31
+
32
+ First, install the required testing dependencies:
33
+ ```bash
34
+ .venv/bin/python -m pip install pytest pytest-cov
35
+ ```
36
+
37
+ ### Basic Usage
38
+
39
+ Run all tests with coverage:
40
+ ```bash
41
+ .venv/bin/python -m pytest --cov --cov-report=html
42
+ ```
43
+
44
+ ### Common Commands
45
+ ```bash
46
+ # Run tests with coverage for a specific module
47
+ .venv/bin/python -m pytest --cov=your_module
48
+
49
+ # Show which lines are not covered
50
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
51
+
52
+ # Generate an HTML coverage report
53
+ .venv/bin/python -m pytest --cov=your_module --cov-report=html
54
+
55
+ # Combine terminal and HTML reports
56
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
57
+
58
+ # Run specific test file with coverage
59
+ .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
60
+ ```
61
+
62
+ ### Viewing HTML Reports
63
+
64
+ After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
65
+
66
+ ### Coverage Threshold
67
+
68
+ To enforce a minimum coverage percentage:
69
+ ```bash
70
+ .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
71
+ ```
72
+
73
+ This will cause the test suite to fail if coverage drops below 80%.
74
+
75
+ ## Code Quality & Typing
76
+
77
+ All the suite packages follow strict quality standards:
78
+
79
+ - **Type hints**: Full type coverage with mypy validation
80
+ - **Code formatting**: Enforced with black and isort
81
+ - **Linting**: Comprehensive checks with custom scripts and tools
82
+ - **Testing**: High test coverage requirements
83
+
84
+ These standards ensure reliability and maintainability across the suite.
85
+
86
+ ## Versioning & Compatibility Policy
87
+
88
+ Wexample packages follow **Semantic Versioning** (SemVer):
89
+
90
+ - **MAJOR**: Breaking changes
91
+ - **MINOR**: New features, backward compatible
92
+ - **PATCH**: Bug fixes, backward compatible
93
+
94
+ We maintain backward compatibility within major versions and provide clear migration guides for breaking changes.
95
+
96
+ ## Changelog
97
+
98
+ See [CHANGELOG.md](CHANGELOG.md) for detailed version history and release notes.
99
+
100
+ Major changes are documented with migration guides when applicable.
101
+
102
+ ## Migration Notes
103
+
104
+ When upgrading between major versions, refer to the migration guides in the documentation.
105
+
106
+ Breaking changes are clearly documented with upgrade paths and examples.
107
+
108
+ ## Known Limitations & Roadmap
109
+
110
+ Current limitations and planned features are tracked in the GitHub issues.
111
+
112
+ See the [project roadmap](https://github.com/wexample/python-filestate-dev/issues) for upcoming features and improvements.
113
+
114
+ ## Security Policy
115
+
116
+ ### Reporting Vulnerabilities
117
+
118
+ If you discover a security vulnerability, please email security@wexample.com.
119
+
120
+ **Do not** open public issues for security vulnerabilities.
121
+
122
+ We take security seriously and will respond promptly to verified reports.
123
+
124
+ ## Privacy & Telemetry
125
+
126
+ This package does **not** collect any telemetry or usage data.
127
+
128
+ Your privacy is respected — no data is transmitted to external services.
129
+
130
+ ## Support Channels
131
+
132
+ - **GitHub Issues**: Bug reports and feature requests
133
+ - **GitHub Discussions**: Questions and community support
134
+ - **Documentation**: Comprehensive guides and API reference
135
+ - **Email**: contact@wexample.com for general inquiries
136
+
137
+ Community support is available through GitHub Discussions.
138
+
139
+ ## Contribution Guidelines
140
+
141
+ We welcome contributions to the Wexample suite!
142
+
143
+ ### How to Contribute
144
+
145
+ 1. **Fork** the repository
146
+ 2. **Create** a feature branch
147
+ 3. **Make** your changes
148
+ 4. **Test** thoroughly
149
+ 5. **Submit** a pull request
150
+
151
+ ## Maintainers & Authors
152
+
153
+ Maintained by the Wexample team and community contributors.
154
+
155
+ See [CONTRIBUTORS.md](CONTRIBUTORS.md) for the full list of contributors.
156
+
157
+ ## License
158
+
159
+ MIT
160
+
161
+ ## Useful Links
162
+
163
+ - **Homepage**: https://github.com/wexample/python-filestate-dev
164
+ - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
165
+ - **Issue Tracker**: https://github.com/wexample/python-filestate-dev/issues
166
+ - **Discussions**: https://github.com/wexample/python-filestate-dev/discussions
167
+ - **PyPI**: [pypi.org/project/wexample-filestate-dev](https://pypi.org/project/wexample-filestate-dev/)
168
+
169
+ ## Integration in the Suite
170
+
171
+ This package is part of the **Wexample Suite** — a collection of high-quality Python packages designed to work seamlessly together.
172
+
173
+ ### Related Packages
174
+
175
+ 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.
176
+
177
+ Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
178
+
179
+ # About us
180
+
181
+ Wexample 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.
182
+
183
+ 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.
184
+
185
+ 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.
186
+
wexample_filestate_dev-0.0.48/README.md ADDED
@@ -0,0 +1,167 @@
1
+ # wexample-filestate-dev
2
+
3
+ Version: 0.0.48
4
+
5
+ Some python basic helpers.
6
+
7
+ ## Tests
8
+
9
+ This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
10
+
11
+ ### Installation
12
+
13
+ First, install the required testing dependencies:
14
+ ```bash
15
+ .venv/bin/python -m pip install pytest pytest-cov
16
+ ```
17
+
18
+ ### Basic Usage
19
+
20
+ Run all tests with coverage:
21
+ ```bash
22
+ .venv/bin/python -m pytest --cov --cov-report=html
23
+ ```
24
+
25
+ ### Common Commands
26
+ ```bash
27
+ # Run tests with coverage for a specific module
28
+ .venv/bin/python -m pytest --cov=your_module
29
+
30
+ # Show which lines are not covered
31
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
32
+
33
+ # Generate an HTML coverage report
34
+ .venv/bin/python -m pytest --cov=your_module --cov-report=html
35
+
36
+ # Combine terminal and HTML reports
37
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
38
+
39
+ # Run specific test file with coverage
40
+ .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
41
+ ```
42
+
43
+ ### Viewing HTML Reports
44
+
45
+ After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
46
+
47
+ ### Coverage Threshold
48
+
49
+ To enforce a minimum coverage percentage:
50
+ ```bash
51
+ .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
52
+ ```
53
+
54
+ This will cause the test suite to fail if coverage drops below 80%.
55
+
56
+ ## Code Quality & Typing
57
+
58
+ All the suite packages follow strict quality standards:
59
+
60
+ - **Type hints**: Full type coverage with mypy validation
61
+ - **Code formatting**: Enforced with black and isort
62
+ - **Linting**: Comprehensive checks with custom scripts and tools
63
+ - **Testing**: High test coverage requirements
64
+
65
+ These standards ensure reliability and maintainability across the suite.
66
+
67
+ ## Versioning & Compatibility Policy
68
+
69
+ Wexample packages follow **Semantic Versioning** (SemVer):
70
+
71
+ - **MAJOR**: Breaking changes
72
+ - **MINOR**: New features, backward compatible
73
+ - **PATCH**: Bug fixes, backward compatible
74
+
75
+ We maintain backward compatibility within major versions and provide clear migration guides for breaking changes.
76
+
77
+ ## Changelog
78
+
79
+ See [CHANGELOG.md](CHANGELOG.md) for detailed version history and release notes.
80
+
81
+ Major changes are documented with migration guides when applicable.
82
+
83
+ ## Migration Notes
84
+
85
+ When upgrading between major versions, refer to the migration guides in the documentation.
86
+
87
+ Breaking changes are clearly documented with upgrade paths and examples.
88
+
89
+ ## Known Limitations & Roadmap
90
+
91
+ Current limitations and planned features are tracked in the GitHub issues.
92
+
93
+ See the [project roadmap](https://github.com/wexample/python-filestate-dev/issues) for upcoming features and improvements.
94
+
95
+ ## Security Policy
96
+
97
+ ### Reporting Vulnerabilities
98
+
99
+ If you discover a security vulnerability, please email security@wexample.com.
100
+
101
+ **Do not** open public issues for security vulnerabilities.
102
+
103
+ We take security seriously and will respond promptly to verified reports.
104
+
105
+ ## Privacy & Telemetry
106
+
107
+ This package does **not** collect any telemetry or usage data.
108
+
109
+ Your privacy is respected — no data is transmitted to external services.
110
+
111
+ ## Support Channels
112
+
113
+ - **GitHub Issues**: Bug reports and feature requests
114
+ - **GitHub Discussions**: Questions and community support
115
+ - **Documentation**: Comprehensive guides and API reference
116
+ - **Email**: contact@wexample.com for general inquiries
117
+
118
+ Community support is available through GitHub Discussions.
119
+
120
+ ## Contribution Guidelines
121
+
122
+ We welcome contributions to the Wexample suite!
123
+
124
+ ### How to Contribute
125
+
126
+ 1. **Fork** the repository
127
+ 2. **Create** a feature branch
128
+ 3. **Make** your changes
129
+ 4. **Test** thoroughly
130
+ 5. **Submit** a pull request
131
+
132
+ ## Maintainers & Authors
133
+
134
+ Maintained by the Wexample team and community contributors.
135
+
136
+ See [CONTRIBUTORS.md](CONTRIBUTORS.md) for the full list of contributors.
137
+
138
+ ## License
139
+
140
+ MIT
141
+
142
+ ## Useful Links
143
+
144
+ - **Homepage**: https://github.com/wexample/python-filestate-dev
145
+ - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
146
+ - **Issue Tracker**: https://github.com/wexample/python-filestate-dev/issues
147
+ - **Discussions**: https://github.com/wexample/python-filestate-dev/discussions
148
+ - **PyPI**: [pypi.org/project/wexample-filestate-dev](https://pypi.org/project/wexample-filestate-dev/)
149
+
150
+ ## Integration in the Suite
151
+
152
+ This package is part of the **Wexample Suite** — a collection of high-quality Python packages designed to work seamlessly together.
153
+
154
+ ### Related Packages
155
+
156
+ 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.
157
+
158
+ Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
159
+
160
+ # About us
161
+
162
+ Wexample 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.
163
+
164
+ 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.
165
+
166
+ 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.
167
+
wexample_filestate_dev-0.0.48/pyproject.toml ADDED
@@ -0,0 +1,86 @@
1
+ [build-system]
2
+ requires = [
3
+ "pdm-backend",
4
+ ]
5
+ build-backend = "pdm.backend"
6
+
7
+ [project]
8
+ name = "wexample-filestate-dev"
9
+ version = "0.0.48"
10
+ description = "Some python basic helpers."
11
+ authors = [
12
+ { name = "weeger", email = "contact@wexample.com" },
13
+ ]
14
+ requires-python = ">=3.10"
15
+ classifiers = [
16
+ "Programming Language :: Python :: 3",
17
+ "License :: OSI Approved :: MIT License",
18
+ "Operating System :: OS Independent",
19
+ ]
20
+ dependencies = [
21
+ "attrs>=23.1.0",
22
+ "cattrs>=23.1.0",
23
+ "wexample-filestate==0.0.71",
24
+ ]
25
+
26
+ [project.readme]
27
+ file = "README.md"
28
+ content-type = "text/markdown"
29
+
30
+ [project.license]
31
+ text = "MIT"
32
+
33
+ [project.urls]
34
+ homepage = "https://github.com/wexample/python-filestate-dev"
35
+
36
+ [project.optional-dependencies]
37
+ dev = [
38
+ "pytest",
39
+ "pytest-cov",
40
+ ]
41
+
42
+ [tool.setuptools.packages.find]
43
+ include = [
44
+ "*",
45
+ ]
46
+ exclude = [
47
+ "wexample_filestate_dev.testing*",
48
+ ]
49
+
50
+ [tool.pdm]
51
+ distribution = true
52
+
53
+ [tool.pdm.build]
54
+ package-dir = "src"
55
+ packages = [
56
+ { include = "wexample_filestate_dev", from = "src" },
57
+ ]
58
+
59
+ [tool.pytest.ini_options]
60
+ testpaths = [
61
+ "tests",
62
+ ]
63
+ pythonpath = [
64
+ "src",
65
+ ]
66
+
67
+ [tool.coverage.run]
68
+ source = [
69
+ "wexample_filestate_dev",
70
+ ]
71
+ omit = [
72
+ "*/tests/*",
73
+ "*/.venv/*",
74
+ "*/venv/*",
75
+ ]
76
+
77
+ [tool.coverage.report]
78
+ exclude_lines = [
79
+ "pragma: no cover",
80
+ "def __repr__",
81
+ "raise AssertionError",
82
+ "raise NotImplementedError",
83
+ "if __name__ == .__main__.:",
84
+ "if TYPE_CHECKING:",
85
+ "@abstractmethod",
86
+ ]