syrtis-python-dataflow 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.
Files changed (6) hide show
  1. syrtis_python_dataflow-1.0.1/PKG-INFO +106 -0
  2. syrtis_python_dataflow-1.0.1/README.md +92 -0
  3. syrtis_python_dataflow-1.0.1/pyproject.toml +78 -0
  4. syrtis_python_dataflow-1.0.1/src/syrtis_syrtis_python_dataflow/__init__.py +0 -0
  5. syrtis_python_dataflow-1.0.1/src/syrtis_syrtis_python_dataflow/py.typed +0 -0
  6. syrtis_python_dataflow-1.0.1/tests/.gitkeep +0 -0
syrtis_python_dataflow-1.0.1/PKG-INFO ADDED
@@ -0,0 +1,106 @@
1
+ Metadata-Version: 2.1
2
+ Name: syrtis-python-dataflow
3
+ Version: 1.0.1
4
+ Author-Email: weeger <contact@syrtis.ai>
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
+ # python-dataflow
16
+
17
+ Version: 1.0.1
18
+
19
+ ## Table of Contents
20
+
21
+ - [Install](#install)
22
+ - [Tests](#tests)
23
+ - [Roadmap](#roadmap)
24
+ - [Status Compatibility](#status-compatibility)
25
+ - [Useful Links](#useful-links)
26
+
27
+ ## Installation
28
+
29
+ ```bash
30
+ pip install syrtis-python-dataflow
31
+ ```
32
+
33
+ Requires Python >=3.10.
34
+
35
+ ## Tests
36
+
37
+ This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
38
+
39
+ ### Installation
40
+
41
+ First, install the required testing dependencies:
42
+ ```bash
43
+ .venv/bin/python -m pip install pytest pytest-cov
44
+ ```
45
+
46
+ ### Basic Usage
47
+
48
+ Run all tests with coverage:
49
+ ```bash
50
+ .venv/bin/python -m pytest --cov --cov-report=html
51
+ ```
52
+
53
+ ### Common Commands
54
+ ```bash
55
+ # Run tests with coverage for a specific module
56
+ .venv/bin/python -m pytest --cov=your_module
57
+
58
+ # Show which lines are not covered
59
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
60
+
61
+ # Generate an HTML coverage report
62
+ .venv/bin/python -m pytest --cov=your_module --cov-report=html
63
+
64
+ # Combine terminal and HTML reports
65
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
66
+
67
+ # Run specific test file with coverage
68
+ .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
69
+ ```
70
+
71
+ ### Viewing HTML Reports
72
+
73
+ After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
74
+
75
+ ### Coverage Threshold
76
+
77
+ To enforce a minimum coverage percentage:
78
+ ```bash
79
+ .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
80
+ ```
81
+
82
+ This will cause the test suite to fail if coverage drops below 80%.
83
+
84
+ ## Known Limitations & Roadmap
85
+
86
+ Current limitations and planned features are tracked in the GitHub issues.
87
+
88
+ See the [project roadmap](https://github.com/wexample/python-python-dataflow/issues) for upcoming features and improvements.
89
+
90
+ ## Status & Compatibility
91
+
92
+ **Maturity**: Production-ready
93
+
94
+ **Python Support**: >=3.10
95
+
96
+ **OS Support**: Linux, macOS, Windows
97
+
98
+ **Status**: Actively maintained
99
+
100
+ ## Useful Links
101
+
102
+ - **Homepage**: https://github.com/wexample/python-python-dataflow
103
+ - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
104
+ - **Issue Tracker**: https://github.com/wexample/python-python-dataflow/issues
105
+ - **Discussions**: https://github.com/wexample/python-python-dataflow/discussions
106
+ - **PyPI**: [pypi.org/project/python-dataflow](https://pypi.org/project/python-dataflow/)
syrtis_python_dataflow-1.0.1/README.md ADDED
@@ -0,0 +1,92 @@
1
+ # python-dataflow
2
+
3
+ Version: 1.0.1
4
+
5
+ ## Table of Contents
6
+
7
+ - [Install](#install)
8
+ - [Tests](#tests)
9
+ - [Roadmap](#roadmap)
10
+ - [Status Compatibility](#status-compatibility)
11
+ - [Useful Links](#useful-links)
12
+
13
+ ## Installation
14
+
15
+ ```bash
16
+ pip install syrtis-python-dataflow
17
+ ```
18
+
19
+ Requires Python >=3.10.
20
+
21
+ ## Tests
22
+
23
+ This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
24
+
25
+ ### Installation
26
+
27
+ First, install the required testing dependencies:
28
+ ```bash
29
+ .venv/bin/python -m pip install pytest pytest-cov
30
+ ```
31
+
32
+ ### Basic Usage
33
+
34
+ Run all tests with coverage:
35
+ ```bash
36
+ .venv/bin/python -m pytest --cov --cov-report=html
37
+ ```
38
+
39
+ ### Common Commands
40
+ ```bash
41
+ # Run tests with coverage for a specific module
42
+ .venv/bin/python -m pytest --cov=your_module
43
+
44
+ # Show which lines are not covered
45
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
46
+
47
+ # Generate an HTML coverage report
48
+ .venv/bin/python -m pytest --cov=your_module --cov-report=html
49
+
50
+ # Combine terminal and HTML reports
51
+ .venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
52
+
53
+ # Run specific test file with coverage
54
+ .venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
55
+ ```
56
+
57
+ ### Viewing HTML Reports
58
+
59
+ After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
60
+
61
+ ### Coverage Threshold
62
+
63
+ To enforce a minimum coverage percentage:
64
+ ```bash
65
+ .venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
66
+ ```
67
+
68
+ This will cause the test suite to fail if coverage drops below 80%.
69
+
70
+ ## Known Limitations & Roadmap
71
+
72
+ Current limitations and planned features are tracked in the GitHub issues.
73
+
74
+ See the [project roadmap](https://github.com/wexample/python-python-dataflow/issues) for upcoming features and improvements.
75
+
76
+ ## Status & Compatibility
77
+
78
+ **Maturity**: Production-ready
79
+
80
+ **Python Support**: >=3.10
81
+
82
+ **OS Support**: Linux, macOS, Windows
83
+
84
+ **Status**: Actively maintained
85
+
86
+ ## Useful Links
87
+
88
+ - **Homepage**: https://github.com/wexample/python-python-dataflow
89
+ - **Documentation**: [docs.wexample.com](https://docs.wexample.com)
90
+ - **Issue Tracker**: https://github.com/wexample/python-python-dataflow/issues
91
+ - **Discussions**: https://github.com/wexample/python-python-dataflow/discussions
92
+ - **PyPI**: [pypi.org/project/python-dataflow](https://pypi.org/project/python-dataflow/)
syrtis_python_dataflow-1.0.1/pyproject.toml ADDED
@@ -0,0 +1,78 @@
1
+ [build-system]
2
+ requires = [
3
+ "pdm-backend",
4
+ ]
5
+ build-backend = "pdm.backend"
6
+
7
+ [project]
8
+ name = "syrtis-python-dataflow"
9
+ version = "1.0.1"
10
+ authors = [
11
+ { name = "weeger", email = "contact@syrtis.ai" },
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
+ "syrtis_python_dataflow.testing*",
40
+ ]
41
+
42
+ [tool.pdm]
43
+ distribution = true
44
+
45
+ [tool.pdm.build]
46
+ package-dir = "src"
47
+ packages = [
48
+ { include = "syrtis_python_dataflow", 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
+ "syrtis_python_dataflow",
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
+ ]
syrtis_python_dataflow-1.0.1/tests/.gitkeep ADDED
File without changes