wexample-storage 1.0.1__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.
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: wexample-storage
|
|
3
|
+
Version: 1.0.1
|
|
4
|
+
Author-Email: weeger <contact@wexample.com>
|
|
5
|
+
License: MIT
|
|
6
|
+
Classifier: Programming Language :: Python :: 3
|
|
7
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
8
|
+
Classifier: Operating System :: OS Independent
|
|
9
|
+
Requires-Python: >=3.10
|
|
10
|
+
Provides-Extra: dev
|
|
11
|
+
Requires-Dist: pytest; extra == "dev"
|
|
12
|
+
Requires-Dist: pytest-cov; extra == "dev"
|
|
13
|
+
Description-Content-Type: text/markdown
|
|
14
|
+
|
|
15
|
+
# storage
|
|
16
|
+
|
|
17
|
+
Version: 1.0.1
|
|
18
|
+
|
|
19
|
+
## Table of Contents
|
|
20
|
+
|
|
21
|
+
- [Installation](#installation)
|
|
22
|
+
- [Tests](#tests)
|
|
23
|
+
- [Integration in the Suite](#integration-in-the-suite)
|
|
24
|
+
- [Versioning & Compatibility Policy](#versioning--compatibility-policy)
|
|
25
|
+
- [License](#license)
|
|
26
|
+
- [About us](#about-us)
|
|
27
|
+
- [Known Limitations & Roadmap](#known-limitations--roadmap)
|
|
28
|
+
- [Status & Compatibility](#status--compatibility)
|
|
29
|
+
- [Useful Links](#useful-links)
|
|
30
|
+
- [Migration Notes](#migration-notes)
|
|
31
|
+
|
|
32
|
+
## Installation
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
pip install wexample-storage
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Requires Python >=3.10.
|
|
39
|
+
|
|
40
|
+
## Tests
|
|
41
|
+
|
|
42
|
+
This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
|
|
43
|
+
|
|
44
|
+
### Installation
|
|
45
|
+
|
|
46
|
+
First, install the required testing dependencies:
|
|
47
|
+
```bash
|
|
48
|
+
.venv/bin/python -m pip install pytest pytest-cov
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Basic Usage
|
|
52
|
+
|
|
53
|
+
Run all tests with coverage:
|
|
54
|
+
```bash
|
|
55
|
+
.venv/bin/python -m pytest --cov --cov-report=html
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Common Commands
|
|
59
|
+
```bash
|
|
60
|
+
# Run tests with coverage for a specific module
|
|
61
|
+
.venv/bin/python -m pytest --cov=your_module
|
|
62
|
+
|
|
63
|
+
# Show which lines are not covered
|
|
64
|
+
.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
|
|
65
|
+
|
|
66
|
+
# Generate an HTML coverage report
|
|
67
|
+
.venv/bin/python -m pytest --cov=your_module --cov-report=html
|
|
68
|
+
|
|
69
|
+
# Combine terminal and HTML reports
|
|
70
|
+
.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
|
|
71
|
+
|
|
72
|
+
# Run specific test file with coverage
|
|
73
|
+
.venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### Viewing HTML Reports
|
|
77
|
+
|
|
78
|
+
After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
|
|
79
|
+
|
|
80
|
+
### Coverage Threshold
|
|
81
|
+
|
|
82
|
+
To enforce a minimum coverage percentage:
|
|
83
|
+
```bash
|
|
84
|
+
.venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
This will cause the test suite to fail if coverage drops below 80%.
|
|
88
|
+
|
|
89
|
+
## Integration in the Suite
|
|
90
|
+
|
|
91
|
+
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.
|
|
92
|
+
|
|
93
|
+
### Related Packages
|
|
94
|
+
|
|
95
|
+
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.
|
|
96
|
+
|
|
97
|
+
Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
|
|
98
|
+
|
|
99
|
+
## Versioning & Compatibility Policy
|
|
100
|
+
|
|
101
|
+
Wexample packages follow **Semantic Versioning** (SemVer):
|
|
102
|
+
|
|
103
|
+
- **MAJOR**: Breaking changes
|
|
104
|
+
- **MINOR**: New features, backward compatible
|
|
105
|
+
- **PATCH**: Bug fixes, backward compatible
|
|
106
|
+
|
|
107
|
+
We maintain backward compatibility within major versions and provide clear migration guides for breaking changes.
|
|
108
|
+
|
|
109
|
+
## License
|
|
110
|
+
|
|
111
|
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
112
|
+
|
|
113
|
+
Free to use in both personal and commercial projects.
|
|
114
|
+
|
|
115
|
+
## About us
|
|
116
|
+
|
|
117
|
+
[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.
|
|
118
|
+
|
|
119
|
+
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.
|
|
120
|
+
|
|
121
|
+
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.
|
|
122
|
+
|
|
123
|
+
## Known Limitations & Roadmap
|
|
124
|
+
|
|
125
|
+
Current limitations and planned features are tracked in the GitHub issues.
|
|
126
|
+
|
|
127
|
+
See the [project roadmap](https://github.com/wexample/python-storage/issues) for upcoming features and improvements.
|
|
128
|
+
|
|
129
|
+
## Status & Compatibility
|
|
130
|
+
|
|
131
|
+
**Maturity**: Production-ready
|
|
132
|
+
|
|
133
|
+
**Python Support**: >=3.10
|
|
134
|
+
|
|
135
|
+
**OS Support**: Linux, macOS, Windows
|
|
136
|
+
|
|
137
|
+
**Status**: Actively maintained
|
|
138
|
+
|
|
139
|
+
## Useful Links
|
|
140
|
+
|
|
141
|
+
- **Homepage**: https://github.com/wexample/python-storage
|
|
142
|
+
- **Documentation**: [docs.wexample.com](https://docs.wexample.com)
|
|
143
|
+
- **Issue Tracker**: https://github.com/wexample/python-storage/issues
|
|
144
|
+
- **Discussions**: https://github.com/wexample/python-storage/discussions
|
|
145
|
+
- **PyPI**: [pypi.org/project/wexample-storage](https://pypi.org/project/wexample-storage/)
|
|
146
|
+
|
|
147
|
+
## Migration Notes
|
|
148
|
+
|
|
149
|
+
When upgrading between major versions, refer to the migration guides in the documentation.
|
|
150
|
+
|
|
151
|
+
Breaking changes are clearly documented with upgrade paths and examples.
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
# storage
|
|
2
|
+
|
|
3
|
+
Version: 1.0.1
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
- [Installation](#installation)
|
|
8
|
+
- [Tests](#tests)
|
|
9
|
+
- [Integration in the Suite](#integration-in-the-suite)
|
|
10
|
+
- [Versioning & Compatibility Policy](#versioning--compatibility-policy)
|
|
11
|
+
- [License](#license)
|
|
12
|
+
- [About us](#about-us)
|
|
13
|
+
- [Known Limitations & Roadmap](#known-limitations--roadmap)
|
|
14
|
+
- [Status & Compatibility](#status--compatibility)
|
|
15
|
+
- [Useful Links](#useful-links)
|
|
16
|
+
- [Migration Notes](#migration-notes)
|
|
17
|
+
|
|
18
|
+
## Installation
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
pip install wexample-storage
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Requires Python >=3.10.
|
|
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
|
+
## Integration in the Suite
|
|
76
|
+
|
|
77
|
+
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.
|
|
78
|
+
|
|
79
|
+
### Related Packages
|
|
80
|
+
|
|
81
|
+
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.
|
|
82
|
+
|
|
83
|
+
Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
|
|
84
|
+
|
|
85
|
+
## Versioning & Compatibility Policy
|
|
86
|
+
|
|
87
|
+
Wexample packages follow **Semantic Versioning** (SemVer):
|
|
88
|
+
|
|
89
|
+
- **MAJOR**: Breaking changes
|
|
90
|
+
- **MINOR**: New features, backward compatible
|
|
91
|
+
- **PATCH**: Bug fixes, backward compatible
|
|
92
|
+
|
|
93
|
+
We maintain backward compatibility within major versions and provide clear migration guides for breaking changes.
|
|
94
|
+
|
|
95
|
+
## License
|
|
96
|
+
|
|
97
|
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
98
|
+
|
|
99
|
+
Free to use in both personal and commercial projects.
|
|
100
|
+
|
|
101
|
+
## About us
|
|
102
|
+
|
|
103
|
+
[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.
|
|
104
|
+
|
|
105
|
+
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.
|
|
106
|
+
|
|
107
|
+
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.
|
|
108
|
+
|
|
109
|
+
## Known Limitations & Roadmap
|
|
110
|
+
|
|
111
|
+
Current limitations and planned features are tracked in the GitHub issues.
|
|
112
|
+
|
|
113
|
+
See the [project roadmap](https://github.com/wexample/python-storage/issues) for upcoming features and improvements.
|
|
114
|
+
|
|
115
|
+
## Status & Compatibility
|
|
116
|
+
|
|
117
|
+
**Maturity**: Production-ready
|
|
118
|
+
|
|
119
|
+
**Python Support**: >=3.10
|
|
120
|
+
|
|
121
|
+
**OS Support**: Linux, macOS, Windows
|
|
122
|
+
|
|
123
|
+
**Status**: Actively maintained
|
|
124
|
+
|
|
125
|
+
## Useful Links
|
|
126
|
+
|
|
127
|
+
- **Homepage**: https://github.com/wexample/python-storage
|
|
128
|
+
- **Documentation**: [docs.wexample.com](https://docs.wexample.com)
|
|
129
|
+
- **Issue Tracker**: https://github.com/wexample/python-storage/issues
|
|
130
|
+
- **Discussions**: https://github.com/wexample/python-storage/discussions
|
|
131
|
+
- **PyPI**: [pypi.org/project/wexample-storage](https://pypi.org/project/wexample-storage/)
|
|
132
|
+
|
|
133
|
+
## Migration Notes
|
|
134
|
+
|
|
135
|
+
When upgrading between major versions, refer to the migration guides in the documentation.
|
|
136
|
+
|
|
137
|
+
Breaking changes are clearly documented with upgrade paths and examples.
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = [
|
|
3
|
+
"pdm-backend",
|
|
4
|
+
]
|
|
5
|
+
build-backend = "pdm.backend"
|
|
6
|
+
|
|
7
|
+
[project]
|
|
8
|
+
name = "wexample-storage"
|
|
9
|
+
version = "1.0.1"
|
|
10
|
+
authors = [
|
|
11
|
+
{ name = "weeger", email = "contact@wexample.com" },
|
|
12
|
+
]
|
|
13
|
+
requires-python = ">=3.10"
|
|
14
|
+
classifiers = [
|
|
15
|
+
"Programming Language :: Python :: 3",
|
|
16
|
+
"License :: OSI Approved :: MIT License",
|
|
17
|
+
"Operating System :: OS Independent",
|
|
18
|
+
]
|
|
19
|
+
dependencies = []
|
|
20
|
+
|
|
21
|
+
[project.readme]
|
|
22
|
+
file = "README.md"
|
|
23
|
+
content-type = "text/markdown"
|
|
24
|
+
|
|
25
|
+
[project.license]
|
|
26
|
+
text = "MIT"
|
|
27
|
+
|
|
28
|
+
[project.optional-dependencies]
|
|
29
|
+
dev = [
|
|
30
|
+
"pytest",
|
|
31
|
+
"pytest-cov",
|
|
32
|
+
]
|
|
33
|
+
|
|
34
|
+
[tool.setuptools.packages.find]
|
|
35
|
+
include = [
|
|
36
|
+
"*",
|
|
37
|
+
]
|
|
38
|
+
exclude = [
|
|
39
|
+
"wexample_storage.testing*",
|
|
40
|
+
]
|
|
41
|
+
|
|
42
|
+
[tool.pdm]
|
|
43
|
+
distribution = true
|
|
44
|
+
|
|
45
|
+
[tool.pdm.build]
|
|
46
|
+
package-dir = "src"
|
|
47
|
+
packages = [
|
|
48
|
+
{ include = "wexample_storage", from = "src" },
|
|
49
|
+
]
|
|
50
|
+
|
|
51
|
+
[tool.pytest.ini_options]
|
|
52
|
+
testpaths = [
|
|
53
|
+
"tests",
|
|
54
|
+
]
|
|
55
|
+
pythonpath = [
|
|
56
|
+
"src",
|
|
57
|
+
]
|
|
58
|
+
|
|
59
|
+
[tool.coverage.run]
|
|
60
|
+
source = [
|
|
61
|
+
"wexample_storage",
|
|
62
|
+
]
|
|
63
|
+
omit = [
|
|
64
|
+
"*/tests/*",
|
|
65
|
+
"*/.venv/*",
|
|
66
|
+
"*/venv/*",
|
|
67
|
+
]
|
|
68
|
+
|
|
69
|
+
[tool.coverage.report]
|
|
70
|
+
exclude_lines = [
|
|
71
|
+
"pragma: no cover",
|
|
72
|
+
"def __repr__",
|
|
73
|
+
"raise AssertionError",
|
|
74
|
+
"raise NotImplementedError",
|
|
75
|
+
"if __name__ == .__main__.:",
|
|
76
|
+
"if TYPE_CHECKING:",
|
|
77
|
+
"@abstractmethod",
|
|
78
|
+
]
|
|
File without changes
|
|
File without changes
|
|
File without changes
|