wexample-filestate-javascript 0.0.7__tar.gz → 0.0.8__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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: wexample-filestate-javascript
3
- Version: 0.0.7
3
+ Version: 0.0.8
4
4
  Author-Email: weeger <contact@wexample.com>
5
5
  License: MIT
6
6
  Classifier: Programming Language :: Python :: 3
@@ -16,10 +16,59 @@ Description-Content-Type: text/markdown
16
16
 
17
17
  # wexample-filestate-javascript
18
18
 
19
- Version: 0.0.7
19
+ Version: 0.0.8
20
20
 
21
21
 
22
22
 
23
+ ## Tests
24
+
25
+ This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
26
+
27
+ ### Installation
28
+
29
+ First, install the required testing dependencies:
30
+ ```bash
31
+ .venv/bin/python -m pip install pytest pytest-cov
32
+ ```
33
+
34
+ ### Basic Usage
35
+
36
+ Run all tests with coverage:
37
+ ```bash
38
+ .venv/bin/python -m pytest --cov
39
+ ```
40
+
41
+ ### Common Commands
42
+ ```bash
43
+ # Run tests with coverage for a specific module
44
+ .venv/bin/python -m pytest --cov=your_module
45
+
46
+ # Show which lines are not covered
47
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
48
+
49
+ # Generate an HTML coverage report
50
+ .venv/bin/python -m pytest --cov=your_module --cov-report=html
51
+
52
+ # Combine terminal and HTML reports
53
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
54
+
55
+ # Run specific test file with coverage
56
+ .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
57
+ ```
58
+
59
+ ### Viewing HTML Reports
60
+
61
+ After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
62
+
63
+ ### Coverage Threshold
64
+
65
+ To enforce a minimum coverage percentage:
66
+ ```bash
67
+ .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
68
+ ```
69
+
70
+ This will cause the test suite to fail if coverage drops below 80%.
71
+
23
72
  ## Code Quality & Typing
24
73
 
25
74
  All the suite packages follow strict quality standards:
@@ -1,9 +1,58 @@
1
1
  # wexample-filestate-javascript
2
2
 
3
- Version: 0.0.7
3
+ Version: 0.0.8
4
4
 
5
5
 
6
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
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
+
7
56
  ## Code Quality & Typing
8
57
 
9
58
  All the suite packages follow strict quality standards:
@@ -6,7 +6,7 @@ build-backend = "pdm.backend"
6
6
 
7
7
  [project]
8
8
  name = "wexample-filestate-javascript"
9
- version = "0.0.7"
9
+ version = "0.0.8"
10
10
  authors = [
11
11
  { name = "weeger", email = "contact@wexample.com" },
12
12
  ]
@@ -1,4 +1,5 @@
1
1
  """Wexample FileState JavaScript package."""
2
+
2
3
  from __future__ import annotations
3
4
 
4
5
  __version__ = "0.0.6"