wexample-filestate-python 0.0.57__tar.gz → 0.0.59__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 (88) hide show
  1. wexample_filestate_python-0.0.59/PKG-INFO +115 -0
  2. wexample_filestate_python-0.0.59/README.md +87 -0
  3. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/pyproject.toml +3 -3
  4. wexample_filestate_python-0.0.57/PKG-INFO +0 -258
  5. wexample_filestate_python-0.0.57/README.md +0 -230
  6. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/__init__.py +0 -0
  7. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/__pycache__/__init__.py +0 -0
  8. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/common/__init__.py +0 -0
  9. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/common/__pycache__/__init__.py +0 -0
  10. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/common/pipy_gateway.py +0 -0
  11. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/config_option/__init__.py +0 -0
  12. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/config_option/__pycache__/__init__.py +0 -0
  13. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/config_option/mixin/__init__.py +0 -0
  14. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/config_option/mixin/__pycache__/__init__.py +0 -0
  15. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/config_option/mixin/with_stdout_wrapping_mixin.py +0 -0
  16. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/config_value/__init__.py +0 -0
  17. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/config_value/__pycache__/__init__.py +0 -0
  18. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/config_value/python_config_value.py +0 -0
  19. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/const/__init__.py +0 -0
  20. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/const/__pycache__/__init__.py +0 -0
  21. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/const/name_pattern.py +0 -0
  22. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/const/path.py +0 -0
  23. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/const/python_file.py +0 -0
  24. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/event/__init__.py +0 -0
  25. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/event/src/__init__.py +0 -0
  26. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/event/src/wexample_event/__init__.py +0 -0
  27. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/file/__init__.py +0 -0
  28. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/file/__pycache__/__init__.py +0 -0
  29. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/file/python_file.py +0 -0
  30. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/helpers/__init__.py +0 -0
  31. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/helpers/__pycache__/__init__.py +0 -0
  32. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/helpers/package.py +0 -0
  33. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/helpers/python/__init__.py +0 -0
  34. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/helpers/toml.py +0 -0
  35. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/__init__.py +0 -0
  36. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/__pycache__/__init__.py +0 -0
  37. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/__init__.py +0 -0
  38. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/abstract_python_file_content_option.py +0 -0
  39. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/add_future_annotations_option.py +0 -0
  40. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/add_return_types_option.py +0 -0
  41. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/class_name_matches_file_name_option.py +0 -0
  42. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/fix_attrs_option.py +0 -0
  43. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/fix_blank_lines_option.py +0 -0
  44. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/format_option.py +0 -0
  45. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/fstringify_option.py +0 -0
  46. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/modernize_typing_option.py +0 -0
  47. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/order_class_attributes_option.py +0 -0
  48. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/order_class_docstring_option.py +0 -0
  49. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/order_class_methods_option.py +0 -0
  50. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/order_constants_option.py +0 -0
  51. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/order_iterable_items_option.py +0 -0
  52. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/order_main_guard_option.py +0 -0
  53. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/order_module_docstring_option.py +0 -0
  54. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/order_module_functions_option.py +0 -0
  55. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/order_module_metadata_option.py +0 -0
  56. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/order_type_checking_block_option.py +0 -0
  57. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/relocate_imports_option.py +0 -0
  58. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/remove_unused_option.py +0 -0
  59. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/sort_imports_option.py +0 -0
  60. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python/unquote_annotations_option.py +0 -0
  61. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/option/python_option.py +0 -0
  62. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/options_provider/__init__.py +0 -0
  63. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/options_provider/__pycache__/__init__.py +0 -0
  64. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/options_provider/python_options_provider.py +0 -0
  65. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/py.typed +0 -0
  66. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/__init__.py +0 -0
  67. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/__pycache__/__init__.py +0 -0
  68. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/python_attrs_utils.py +0 -0
  69. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/python_blank_lines_utils.py +0 -0
  70. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/python_class_attributes_utils.py +0 -0
  71. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/python_class_docstring_utils.py +0 -0
  72. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/python_class_methods_utils.py +0 -0
  73. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/python_constants_utils.py +0 -0
  74. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/python_docstring_utils.py +0 -0
  75. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/python_functions_utils.py +0 -0
  76. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/python_iterable_utils.py +0 -0
  77. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/python_main_guard_utils.py +0 -0
  78. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/python_module_metadata_utils.py +0 -0
  79. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/python_type_checking_utils.py +0 -0
  80. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/relocate_imports/__init__.py +0 -0
  81. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/relocate_imports/__pycache__/__init__.py +0 -0
  82. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/relocate_imports/python_import_rewriter.py +0 -0
  83. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/relocate_imports/python_localize_runtime_imports.py +0 -0
  84. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/relocate_imports/python_parser_import_index.py +0 -0
  85. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/relocate_imports/python_runtime_symbol_collector.py +0 -0
  86. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/src/wexample_filestate_python/utils/relocate_imports/python_usage_collector.py +0 -0
  87. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/tests/tests/__init__.py +0 -0
  88. {wexample_filestate_python-0.0.57 → wexample_filestate_python-0.0.59}/tests/wexample_tests/__init__.py +0 -0
@@ -0,0 +1,115 @@
1
+ Metadata-Version: 2.1
2
+ Name: wexample-filestate-python
3
+ Version: 0.0.59
4
+ Summary: Helpers for Python.
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-python
11
+ Requires-Python: >=3.10
12
+ Requires-Dist: attrs>=23.1.0
13
+ Requires-Dist: autoflake
14
+ Requires-Dist: black
15
+ Requires-Dist: cattrs>=23.1.0
16
+ Requires-Dist: flynt
17
+ Requires-Dist: isort
18
+ Requires-Dist: libcst
19
+ Requires-Dist: packaging
20
+ Requires-Dist: pyupgrade
21
+ Requires-Dist: tomli
22
+ Requires-Dist: wexample-api==0.0.84
23
+ Requires-Dist: wexample-filestate==0.0.75
24
+ Provides-Extra: dev
25
+ Requires-Dist: pytest; extra == "dev"
26
+ Requires-Dist: pytest-cov; extra == "dev"
27
+ Description-Content-Type: text/markdown
28
+
29
+ # wexample-filestate-python
30
+
31
+ Version: 0.0.59
32
+
33
+ Helpers for Python.
34
+
35
+ ## Table of Contents
36
+
37
+ - [Status Compatibility](#status-compatibility)
38
+ - [Tests](#tests)
39
+ - [Roadmap](#roadmap)
40
+ - [Useful Links](#useful-links)
41
+
42
+
43
+ ## Status & Compatibility
44
+
45
+ **Maturity**: Production-ready
46
+
47
+ **Python Support**: >=3.10
48
+
49
+ **OS Support**: Linux, macOS, Windows
50
+
51
+ **Status**: Actively maintained
52
+
53
+ ## Tests
54
+
55
+ This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
56
+
57
+ ### Installation
58
+
59
+ First, install the required testing dependencies:
60
+ ```bash
61
+ .venv/bin/python -m pip install pytest pytest-cov
62
+ ```
63
+
64
+ ### Basic Usage
65
+
66
+ Run all tests with coverage:
67
+ ```bash
68
+ .venv/bin/python -m pytest --cov --cov-report=html
69
+ ```
70
+
71
+ ### Common Commands
72
+ ```bash
73
+ # Run tests with coverage for a specific module
74
+ .venv/bin/python -m pytest --cov=your_module
75
+
76
+ # Show which lines are not covered
77
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
78
+
79
+ # Generate an HTML coverage report
80
+ .venv/bin/python -m pytest --cov=your_module --cov-report=html
81
+
82
+ # Combine terminal and HTML reports
83
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
84
+
85
+ # Run specific test file with coverage
86
+ .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
87
+ ```
88
+
89
+ ### Viewing HTML Reports
90
+
91
+ After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
92
+
93
+ ### Coverage Threshold
94
+
95
+ To enforce a minimum coverage percentage:
96
+ ```bash
97
+ .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
98
+ ```
99
+
100
+ This will cause the test suite to fail if coverage drops below 80%.
101
+
102
+ ## Known Limitations & Roadmap
103
+
104
+ Current limitations and planned features are tracked in the GitHub issues.
105
+
106
+ See the [project roadmap](https://github.com/wexample/python-filestate_python/issues) for upcoming features and improvements.
107
+
108
+ ## Useful Links
109
+
110
+ - **Homepage**: https://github.com/wexample/python-filestate-python
111
+ - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
112
+ - **Issue Tracker**: https://github.com/wexample/python-filestate-python/issues
113
+ - **Discussions**: https://github.com/wexample/python-filestate-python/discussions
114
+ - **PyPI**: [pypi.org/project/wexample-filestate-python](https://pypi.org/project/wexample-filestate-python/)
115
+
@@ -0,0 +1,87 @@
1
+ # wexample-filestate-python
2
+
3
+ Version: 0.0.59
4
+
5
+ Helpers for Python.
6
+
7
+ ## Table of Contents
8
+
9
+ - [Status Compatibility](#status-compatibility)
10
+ - [Tests](#tests)
11
+ - [Roadmap](#roadmap)
12
+ - [Useful Links](#useful-links)
13
+
14
+
15
+ ## Status & Compatibility
16
+
17
+ **Maturity**: Production-ready
18
+
19
+ **Python Support**: >=3.10
20
+
21
+ **OS Support**: Linux, macOS, Windows
22
+
23
+ **Status**: Actively maintained
24
+
25
+ ## Tests
26
+
27
+ This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
28
+
29
+ ### Installation
30
+
31
+ First, install the required testing dependencies:
32
+ ```bash
33
+ .venv/bin/python -m pip install pytest pytest-cov
34
+ ```
35
+
36
+ ### Basic Usage
37
+
38
+ Run all tests with coverage:
39
+ ```bash
40
+ .venv/bin/python -m pytest --cov --cov-report=html
41
+ ```
42
+
43
+ ### Common Commands
44
+ ```bash
45
+ # Run tests with coverage for a specific module
46
+ .venv/bin/python -m pytest --cov=your_module
47
+
48
+ # Show which lines are not covered
49
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
50
+
51
+ # Generate an HTML coverage report
52
+ .venv/bin/python -m pytest --cov=your_module --cov-report=html
53
+
54
+ # Combine terminal and HTML reports
55
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
56
+
57
+ # Run specific test file with coverage
58
+ .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
59
+ ```
60
+
61
+ ### Viewing HTML Reports
62
+
63
+ After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
64
+
65
+ ### Coverage Threshold
66
+
67
+ To enforce a minimum coverage percentage:
68
+ ```bash
69
+ .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
70
+ ```
71
+
72
+ This will cause the test suite to fail if coverage drops below 80%.
73
+
74
+ ## Known Limitations & Roadmap
75
+
76
+ Current limitations and planned features are tracked in the GitHub issues.
77
+
78
+ See the [project roadmap](https://github.com/wexample/python-filestate_python/issues) for upcoming features and improvements.
79
+
80
+ ## Useful Links
81
+
82
+ - **Homepage**: https://github.com/wexample/python-filestate-python
83
+ - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
84
+ - **Issue Tracker**: https://github.com/wexample/python-filestate-python/issues
85
+ - **Discussions**: https://github.com/wexample/python-filestate-python/discussions
86
+ - **PyPI**: [pypi.org/project/wexample-filestate-python](https://pypi.org/project/wexample-filestate-python/)
87
+
@@ -6,7 +6,7 @@ build-backend = "pdm.backend"
6
6
 
7
7
  [project]
8
8
  name = "wexample-filestate-python"
9
- version = "0.0.57"
9
+ version = "0.0.59"
10
10
  description = "Helpers for Python."
11
11
  authors = [
12
12
  { name = "weeger", email = "contact@wexample.com" },
@@ -28,8 +28,8 @@ dependencies = [
28
28
  "packaging",
29
29
  "pyupgrade",
30
30
  "tomli",
31
- "wexample-api==0.0.81",
32
- "wexample-filestate==0.0.72",
31
+ "wexample-api==0.0.84",
32
+ "wexample-filestate==0.0.75",
33
33
  ]
34
34
 
35
35
  [project.readme]
@@ -1,258 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: wexample-filestate-python
3
- Version: 0.0.57
4
- Summary: Helpers for Python.
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-python
11
- Requires-Python: >=3.10
12
- Requires-Dist: attrs>=23.1.0
13
- Requires-Dist: autoflake
14
- Requires-Dist: black
15
- Requires-Dist: cattrs>=23.1.0
16
- Requires-Dist: flynt
17
- Requires-Dist: isort
18
- Requires-Dist: libcst
19
- Requires-Dist: packaging
20
- Requires-Dist: pyupgrade
21
- Requires-Dist: tomli
22
- Requires-Dist: wexample-api==0.0.81
23
- Requires-Dist: wexample-filestate==0.0.72
24
- Provides-Extra: dev
25
- Requires-Dist: pytest; extra == "dev"
26
- Requires-Dist: pytest-cov; extra == "dev"
27
- Description-Content-Type: text/markdown
28
-
29
- # wexample-filestate-python
30
-
31
- Version: 0.0.57
32
-
33
- Helpers for Python.
34
-
35
- ## Table of Contents
36
-
37
- - [Status Compatibility](#status-compatibility)
38
- - [Api Reference](#api-reference)
39
- - [Tests](#tests)
40
- - [Code Quality](#code-quality)
41
- - [Versioning](#versioning)
42
- - [Changelog](#changelog)
43
- - [Migration Notes](#migration-notes)
44
- - [Roadmap](#roadmap)
45
- - [Security](#security)
46
- - [Privacy](#privacy)
47
- - [Support](#support)
48
- - [Contribution Guidelines](#contribution-guidelines)
49
- - [Maintainers](#maintainers)
50
- - [License](#license)
51
- - [Useful Links](#useful-links)
52
- - [Suite Integration](#suite-integration)
53
- - [Compatibility Matrix](#compatibility-matrix)
54
- - [Dependencies](#dependencies)
55
- - [Suite Signature](#suite-signature)
56
-
57
-
58
- ## Status & Compatibility
59
-
60
- **Maturity**: Production-ready
61
-
62
- **Python Support**: >=3.10
63
-
64
- **OS Support**: Linux, macOS, Windows
65
-
66
- **Status**: Actively maintained
67
-
68
- ## API Reference
69
-
70
- Full API documentation is available in the source code docstrings.
71
-
72
- Key modules and classes are documented with type hints for better IDE support.
73
-
74
- ## Tests
75
-
76
- This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
77
-
78
- ### Installation
79
-
80
- First, install the required testing dependencies:
81
- ```bash
82
- .venv/bin/python -m pip install pytest pytest-cov
83
- ```
84
-
85
- ### Basic Usage
86
-
87
- Run all tests with coverage:
88
- ```bash
89
- .venv/bin/python -m pytest --cov --cov-report=html
90
- ```
91
-
92
- ### Common Commands
93
- ```bash
94
- # Run tests with coverage for a specific module
95
- .venv/bin/python -m pytest --cov=your_module
96
-
97
- # Show which lines are not covered
98
- .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
99
-
100
- # Generate an HTML coverage report
101
- .venv/bin/python -m pytest --cov=your_module --cov-report=html
102
-
103
- # Combine terminal and HTML reports
104
- .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
105
-
106
- # Run specific test file with coverage
107
- .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
108
- ```
109
-
110
- ### Viewing HTML Reports
111
-
112
- After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
113
-
114
- ### Coverage Threshold
115
-
116
- To enforce a minimum coverage percentage:
117
- ```bash
118
- .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
119
- ```
120
-
121
- This will cause the test suite to fail if coverage drops below 80%.
122
-
123
- ## Code Quality & Typing
124
-
125
- All the suite packages follow strict quality standards:
126
-
127
- - **Type hints**: Full type coverage with mypy validation
128
- - **Code formatting**: Enforced with black and isort
129
- - **Linting**: Comprehensive checks with custom scripts and tools
130
- - **Testing**: High test coverage requirements
131
-
132
- These standards ensure reliability and maintainability across the suite.
133
-
134
- ## Versioning & Compatibility Policy
135
-
136
- Wexample packages follow **Semantic Versioning** (SemVer):
137
-
138
- - **MAJOR**: Breaking changes
139
- - **MINOR**: New features, backward compatible
140
- - **PATCH**: Bug fixes, backward compatible
141
-
142
- We maintain backward compatibility within major versions and provide clear migration guides for breaking changes.
143
-
144
- ## Changelog
145
-
146
- See [CHANGELOG.md](CHANGELOG.md) for detailed version history and release notes.
147
-
148
- Major changes are documented with migration guides when applicable.
149
-
150
- ## Migration Notes
151
-
152
- When upgrading between major versions, refer to the migration guides in the documentation.
153
-
154
- Breaking changes are clearly documented with upgrade paths and examples.
155
-
156
- ## Known Limitations & Roadmap
157
-
158
- Current limitations and planned features are tracked in the GitHub issues.
159
-
160
- See the [project roadmap](https://github.com/wexample/python-filestate_python/issues) for upcoming features and improvements.
161
-
162
- ## Security Policy
163
-
164
- ### Reporting Vulnerabilities
165
-
166
- If you discover a security vulnerability, please email contact@wexample.com.
167
-
168
- **Do not** open public issues for security vulnerabilities.
169
-
170
- We take security seriously and will respond promptly to verified reports.
171
-
172
- ## Privacy & Telemetry
173
-
174
- This package does **not** collect any telemetry or usage data.
175
-
176
- Your privacy is respected — no data is transmitted to external services.
177
-
178
- ## Support Channels
179
-
180
- - **GitHub Issues**: Bug reports and feature requests
181
- - **GitHub Discussions**: Questions and community support
182
- - **Documentation**: Comprehensive guides and API reference
183
- - **Email**: contact@wexample.com for general inquiries
184
-
185
- Community support is available through GitHub Discussions.
186
-
187
- ## Contribution Guidelines
188
-
189
- We welcome contributions to the Wexample suite!
190
-
191
- ### How to Contribute
192
-
193
- 1. **Fork** the repository
194
- 2. **Create** a feature branch
195
- 3. **Make** your changes
196
- 4. **Test** thoroughly
197
- 5. **Submit** a pull request
198
-
199
- ## Maintainers & Authors
200
-
201
- Maintained by the Wexample team and community contributors.
202
-
203
- See [CONTRIBUTORS.md](CONTRIBUTORS.md) for the full list of contributors.
204
-
205
- ## License
206
-
207
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
208
-
209
- Free to use in both personal and commercial projects.
210
-
211
- ## Useful Links
212
-
213
- - **Homepage**: https://github.com/wexample/python-filestate-python
214
- - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
215
- - **Issue Tracker**: https://github.com/wexample/python-filestate-python/issues
216
- - **Discussions**: https://github.com/wexample/python-filestate-python/discussions
217
- - **PyPI**: [pypi.org/project/wexample-filestate-python](https://pypi.org/project/wexample-filestate-python/)
218
-
219
- ## Integration in the Suite
220
-
221
- This package is part of the **Wexample Suite** — a collection of high-quality Python packages designed to work seamlessly together.
222
-
223
- ### Related Packages
224
-
225
- 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.
226
-
227
- Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
228
-
229
- ## Compatibility Matrix
230
-
231
- This package is part of the Wexample suite and is compatible with other suite packages.
232
-
233
- Refer to each package's documentation for specific version compatibility requirements.
234
-
235
- ## Dependencies
236
-
237
- - attrs: >=23.1.0
238
- - autoflake:
239
- - black:
240
- - cattrs: >=23.1.0
241
- - flynt:
242
- - isort:
243
- - libcst:
244
- - packaging:
245
- - pyupgrade:
246
- - tomli:
247
- - wexample-api: ==0.0.81
248
- - wexample-filestate: ==0.0.72
249
-
250
-
251
- # About us
252
-
253
- [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.
254
-
255
- 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.
256
-
257
- 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.
258
-
@@ -1,230 +0,0 @@
1
- # wexample-filestate-python
2
-
3
- Version: 0.0.57
4
-
5
- Helpers for Python.
6
-
7
- ## Table of Contents
8
-
9
- - [Status Compatibility](#status-compatibility)
10
- - [Api Reference](#api-reference)
11
- - [Tests](#tests)
12
- - [Code Quality](#code-quality)
13
- - [Versioning](#versioning)
14
- - [Changelog](#changelog)
15
- - [Migration Notes](#migration-notes)
16
- - [Roadmap](#roadmap)
17
- - [Security](#security)
18
- - [Privacy](#privacy)
19
- - [Support](#support)
20
- - [Contribution Guidelines](#contribution-guidelines)
21
- - [Maintainers](#maintainers)
22
- - [License](#license)
23
- - [Useful Links](#useful-links)
24
- - [Suite Integration](#suite-integration)
25
- - [Compatibility Matrix](#compatibility-matrix)
26
- - [Dependencies](#dependencies)
27
- - [Suite Signature](#suite-signature)
28
-
29
-
30
- ## Status & Compatibility
31
-
32
- **Maturity**: Production-ready
33
-
34
- **Python Support**: >=3.10
35
-
36
- **OS Support**: Linux, macOS, Windows
37
-
38
- **Status**: Actively maintained
39
-
40
- ## API Reference
41
-
42
- Full API documentation is available in the source code docstrings.
43
-
44
- Key modules and classes are documented with type hints for better IDE support.
45
-
46
- ## Tests
47
-
48
- This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
49
-
50
- ### Installation
51
-
52
- First, install the required testing dependencies:
53
- ```bash
54
- .venv/bin/python -m pip install pytest pytest-cov
55
- ```
56
-
57
- ### Basic Usage
58
-
59
- Run all tests with coverage:
60
- ```bash
61
- .venv/bin/python -m pytest --cov --cov-report=html
62
- ```
63
-
64
- ### Common Commands
65
- ```bash
66
- # Run tests with coverage for a specific module
67
- .venv/bin/python -m pytest --cov=your_module
68
-
69
- # Show which lines are not covered
70
- .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
71
-
72
- # Generate an HTML coverage report
73
- .venv/bin/python -m pytest --cov=your_module --cov-report=html
74
-
75
- # Combine terminal and HTML reports
76
- .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
77
-
78
- # Run specific test file with coverage
79
- .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
80
- ```
81
-
82
- ### Viewing HTML Reports
83
-
84
- After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
85
-
86
- ### Coverage Threshold
87
-
88
- To enforce a minimum coverage percentage:
89
- ```bash
90
- .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
91
- ```
92
-
93
- This will cause the test suite to fail if coverage drops below 80%.
94
-
95
- ## Code Quality & Typing
96
-
97
- All the suite packages follow strict quality standards:
98
-
99
- - **Type hints**: Full type coverage with mypy validation
100
- - **Code formatting**: Enforced with black and isort
101
- - **Linting**: Comprehensive checks with custom scripts and tools
102
- - **Testing**: High test coverage requirements
103
-
104
- These standards ensure reliability and maintainability across the suite.
105
-
106
- ## Versioning & Compatibility Policy
107
-
108
- Wexample packages follow **Semantic Versioning** (SemVer):
109
-
110
- - **MAJOR**: Breaking changes
111
- - **MINOR**: New features, backward compatible
112
- - **PATCH**: Bug fixes, backward compatible
113
-
114
- We maintain backward compatibility within major versions and provide clear migration guides for breaking changes.
115
-
116
- ## Changelog
117
-
118
- See [CHANGELOG.md](CHANGELOG.md) for detailed version history and release notes.
119
-
120
- Major changes are documented with migration guides when applicable.
121
-
122
- ## Migration Notes
123
-
124
- When upgrading between major versions, refer to the migration guides in the documentation.
125
-
126
- Breaking changes are clearly documented with upgrade paths and examples.
127
-
128
- ## Known Limitations & Roadmap
129
-
130
- Current limitations and planned features are tracked in the GitHub issues.
131
-
132
- See the [project roadmap](https://github.com/wexample/python-filestate_python/issues) for upcoming features and improvements.
133
-
134
- ## Security Policy
135
-
136
- ### Reporting Vulnerabilities
137
-
138
- If you discover a security vulnerability, please email contact@wexample.com.
139
-
140
- **Do not** open public issues for security vulnerabilities.
141
-
142
- We take security seriously and will respond promptly to verified reports.
143
-
144
- ## Privacy & Telemetry
145
-
146
- This package does **not** collect any telemetry or usage data.
147
-
148
- Your privacy is respected — no data is transmitted to external services.
149
-
150
- ## Support Channels
151
-
152
- - **GitHub Issues**: Bug reports and feature requests
153
- - **GitHub Discussions**: Questions and community support
154
- - **Documentation**: Comprehensive guides and API reference
155
- - **Email**: contact@wexample.com for general inquiries
156
-
157
- Community support is available through GitHub Discussions.
158
-
159
- ## Contribution Guidelines
160
-
161
- We welcome contributions to the Wexample suite!
162
-
163
- ### How to Contribute
164
-
165
- 1. **Fork** the repository
166
- 2. **Create** a feature branch
167
- 3. **Make** your changes
168
- 4. **Test** thoroughly
169
- 5. **Submit** a pull request
170
-
171
- ## Maintainers & Authors
172
-
173
- Maintained by the Wexample team and community contributors.
174
-
175
- See [CONTRIBUTORS.md](CONTRIBUTORS.md) for the full list of contributors.
176
-
177
- ## License
178
-
179
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
180
-
181
- Free to use in both personal and commercial projects.
182
-
183
- ## Useful Links
184
-
185
- - **Homepage**: https://github.com/wexample/python-filestate-python
186
- - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
187
- - **Issue Tracker**: https://github.com/wexample/python-filestate-python/issues
188
- - **Discussions**: https://github.com/wexample/python-filestate-python/discussions
189
- - **PyPI**: [pypi.org/project/wexample-filestate-python](https://pypi.org/project/wexample-filestate-python/)
190
-
191
- ## Integration in the Suite
192
-
193
- This package is part of the **Wexample Suite** — a collection of high-quality Python packages designed to work seamlessly together.
194
-
195
- ### Related Packages
196
-
197
- 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.
198
-
199
- Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
200
-
201
- ## Compatibility Matrix
202
-
203
- This package is part of the Wexample suite and is compatible with other suite packages.
204
-
205
- Refer to each package's documentation for specific version compatibility requirements.
206
-
207
- ## Dependencies
208
-
209
- - attrs: >=23.1.0
210
- - autoflake:
211
- - black:
212
- - cattrs: >=23.1.0
213
- - flynt:
214
- - isort:
215
- - libcst:
216
- - packaging:
217
- - pyupgrade:
218
- - tomli:
219
- - wexample-api: ==0.0.81
220
- - wexample-filestate: ==0.0.72
221
-
222
-
223
- # About us
224
-
225
- [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.
226
-
227
- 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.
228
-
229
- 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.
230
-