helpers
Version: 20.6.0
Provides helper functions for strings, dicts, files, shell commands, and JSON, plus a BaseClass enforcing typed field visibility
Table of Contents
Installation
pip install wexample-helpers
Requires Python >=3.10.
Tests
This project uses pytest for testing and pytest-cov for code coverage analysis.
Installation
First, install the required testing dependencies:
.venv/bin/python -m pip install pytest pytest-cov
Basic Usage
Run all tests with coverage:
.venv/bin/python -m pytest --cov --cov-report=html
Common Commands
# 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:
.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%.
Known Limitations & Roadmap
Current limitations and planned features are tracked in the GitHub issues.
See the project roadmap for upcoming features and improvements.
Status & Compatibility
Maturity: Production-ready
Python Support: >=3.10
OS Support: Linux, macOS, Windows
Status: Actively maintained
Useful Links
- Homepage: https://github.com/wexample/python-helpers
- Issue Tracker: https://github.com/wexample/python-helpers/issues
- Discussions: https://github.com/wexample/python-helpers/discussions
- PyPI: pypi.org/project/wexample-helpers
1 maintainer
Metadata
1 maintainer
Release files for wexample-helpers 20.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| wexample_helpers-20.6.0.tar.gz | 92.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| wexample_helpers-20.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 206.4 kB
Release files / wexample_helpers-20.6.0.tar.gz
| Download URL | wexample_helpers-20.6.0.tar.gz |
|---|---|
| Size | 92.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f31f7cbb9a7ccd51b5a4ea79831aa2a506ccd7ebb42d075f78e91b0126bcb219
|
|
BLAKE2b-256 checksum How to use checksums |
d6cde130c496b2ac4cdc22544f131aefba740220a131112bdf762c5a21fe7a34
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
pdm/2.29.3 CPython/3.12.3 Linux/6.1.0-37-amd64
|
Release files / wexample_helpers-20.6.0-py3-none-any.whl
| Download URL | wexample_helpers-20.6.0-py3-none-any.whl |
|---|---|
| Size | 113.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f92bb5458449780e81c84985a100091ea468622977d26e1e5cf63a01982923e7
|
|
BLAKE2b-256 checksum How to use checksums |
38da165262d8206ddcce656865b27f49d120bc5f6a585294858d3596419b4ad3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
pdm/2.29.3 CPython/3.12.3 Linux/6.1.0-37-amd64
|
Security for wexample-helpers 20.6.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
