datafun-streaming 0.1.0__tar.gz → 0.2.0__tar.gz

{datafun_streaming-0.1.0 → datafun_streaming-0.2.0}/CHANGELOG.md

@@ -13,6 +13,15 @@ and this project adheres to **[Semantic Versioning](https://semver.org/spec/v2.0
 
 ---
 
+## [0.2.0] - 2026-05-08
+
+### Changed
+
+- updated README.md
+- added `npx markdownlint-cli2 --fix` to pre-commit
+
+---
+
 ## [0.1.0] - 2026-05-08
 
 ### Added
@@ -62,7 +71,7 @@ Follow these steps exactly when creating a new release.
 1.2. CHANGELOG.md: add section, move unreleased entries, update links
 1.3. pyproject.toml - update [tool.hatch.version].fallback-version (near the end)
 
-### Task 2. Sync Version and Validate
+### Task 2. Validate
 
 ```shell
 uv sync --extra dev --extra docs --upgrade
@@ -72,7 +81,6 @@ uv run python -m pyright
 uv run python -m pytest
 uv run python -m zensical build
 uvx validate-pyproject[all] pyproject.toml
-
 uv build
 uv run python -m twine check dist/\*
 ```
@@ -101,7 +109,8 @@ git push origin :refs/tags/vX.Z.Y
 
 ## Links
 
-[Unreleased]: https://github.com/denisecase/datafun-streaming/compare/v0.1.0...HEAD
+[Unreleased]: https://github.com/denisecase/datafun-streaming/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/denisecase/datafun-streaming/releases/tag/v0.2.0
 [0.1.0]: https://github.com/denisecase/datafun-streaming/releases/tag/v0.1.0
 
 <!-- markdownlint-enable MD024 -->

{datafun_streaming-0.1.0 → datafun_streaming-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datafun-streaming
-Version: 0.1.0
+Version: 0.2.0
 Summary: Utilities for streaming data analytics with Kafka and DuckDB.
 Project-URL: Homepage, https://github.com/denisecase/datafun-streaming
 Project-URL: Repository, https://github.com/denisecase/datafun-streaming
@@ -101,68 +101,3 @@ git push -u origin main
 ```
 
 </details>
-
-## Notes
-
-- Use the **UP ARROW** and **DOWN ARROW** in the terminal to scroll through past commands.
-- Use `CTRL+f` to find (and replace) text within a file.
-- You do not need to add to or modify `tests/`. They are provided for example only.
-- Many files are silent helpers. Explore as you like, but nothing is required.
-- You do NOT not to understand everything; understanding builds naturally over time.
-
-## Troubleshooting >>> or
-
-If you see something like this in your terminal: `>>>` or `...`
-You accidentally started Python interactive mode.
-It happens.
-Press `Ctrl+c` (both keys together) or `Ctrl+Z` then `Enter` on Windows.
-
-## Example Output
-
-```shell
-| INFO | P01 | ========================
-| INFO | P01 | START main()
-| INFO | P01 | ========================
-| INFO | P01 | ROOT_DIR = .
-| INFO | P01 | DATA_DIR = data
-| INFO | P01 | OUTPUT_CSV = data\sales.csv
-| INFO | P01 | Streaming 3 sales to C:\Repos\streaming\datafun-streaming\data\sales.csv ...
-| INFO | P01 | Watch each sale arrive. Press CTRL+C to stop early.
-
-| INFO | P01 | (1, 81.87, 'Backpack', 'East')
-| INFO | P01 | Generated formatted multi-line SUMMARY string.
-| INFO | P01 | Returning the str to the calling function.
-| INFO | P01 |
-    Descriptive Statistics for Streaming Sales Amounts ($):
-        Count of sales   : 1
-        Minimum sale     : $81.87
-        Maximum sale     : $81.87
-        Average sale     : $81.87
-        Standard deviation: $0.00
-
-| INFO | P01 | (2, 101.58, 'Water Bottle', 'North')
-| INFO | P01 | Generated formatted multi-line SUMMARY string.
-| INFO | P01 | Returning the str to the calling function.
-| INFO | P01 |
-    Descriptive Statistics for Streaming Sales Amounts ($):
-        Count of sales   : 2
-        Minimum sale     : $81.87
-        Maximum sale     : $101.58
-        Average sale     : $91.72
-        Standard deviation: $13.94
-
-| INFO | P01 | (3, 27.15, 'Running Shoes', 'East')
-| INFO | P01 | Generated formatted multi-line SUMMARY string.
-| INFO | P01 | Returning the str to the calling function.
-| INFO | P01 |
-    Descriptive Statistics for Streaming Sales Amounts ($):
-        Count of sales   : 3
-        Minimum sale     : $27.15
-        Maximum sale     : $101.58
-        Average sale     : $70.20
-        Standard deviation: $38.56
-
-| INFO | P01 | ========================
-| INFO | P01 | Producer executed successfully!
-| INFO | P01 | ========================
-```

datafun_streaming-0.2.0/README.md

@@ -0,0 +1,64 @@
+# datafun-streaming
+
+[![Adaptive Interfaces](https://img.shields.io/badge/adaptive--interfaces-schema-blue?logo=github)](https://github.com/denisecase)
+[![PyPI](https://img.shields.io/pypi/v/datafun-streaming?logo=pypi&label=pypi)](https://pypi.org/project/datafun-streaming/)
+[![Docs Site](https://img.shields.io/badge/docs-site-blue?logo=github)](https://denisecase.github.io/datafun-streaming/)
+[![Repo](https://img.shields.io/badge/repo-GitHub-black?logo=github)](https://github.com/denisecase/datafun-streaming)
+[![Python 3.15+](https://img.shields.io/badge/python-3.15%2B-blue?logo=python)](https://github.com/denisecase/datafun-streaming/blob/main/pyproject.toml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+[![CI](https://github.com/denisecase/datafun-streaming/actions/workflows/ci-python-zensical.yml/badge.svg?branch=main)](https://github.com/denisecase/datafun-streaming/actions/workflows/ci-python-zensical.yml)
+[![Docs](https://github.com/denisecase/datafun-streaming/actions/workflows/deploy-zensical.yml/badge.svg?branch=main)](https://github.com/denisecase/datafun-streaming/actions/workflows/deploy-zensical.yml)
+[![Links](https://github.com/denisecase/datafun-streaming/actions/workflows/links.yml/badge.svg?branch=main)](https://github.com/denisecase/datafun-streaming/actions/workflows/links.yml)
+
+> Shared Python utilities for Kafka, DuckDB, validation, stats, and visualization
+> across streaming data analytics projects.
+
+## Command Reference
+
+<details>
+<summary>Show command reference</summary>
+
+### In a machine terminal
+
+Open a machine terminal where you want the project:
+
+```shell
+git clone https://github.com/denisecase/datafun-streaming
+
+cd datafun-streaming
+code .
+```
+
+### In a VS Code terminal
+
+```shell
+# reset uv cache only after suspected cache corruption or strange dependency errors
+# uv cache clean
+
+uv self update
+uv python pin 3.14
+uv sync --extra dev --extra docs --upgrade
+
+uvx pre-commit install
+
+git add -A
+uvx pre-commit run --all-files
+# repeat if changes were made
+git add -A
+uvx pre-commit run --all-files
+
+# do chores
+uv run python -m ruff format .
+uv run python -m ruff check . --fix
+uv run python -m pyright
+uv run python -m pytest
+uv run python -m zensical build
+
+# save progress
+git add -A
+git commit -m "update"
+git push -u origin main
+```
+
+</details>

{datafun_streaming-0.1.0 → datafun_streaming-0.2.0}/pyproject.toml

@@ -226,5 +226,5 @@ packages = ["src/datafun_streaming"]  # REQ.PACKAGES: Discovery rooted at src/.
 [tool.hatch.version]
 # WHY: Version derived from git tags at build time, no manual source file edits.
 source = "vcs"
-fallback-version = "0.1.0"              # Used when no git tags present (fresh clone, CI).
+fallback-version = "0.2.0"              # Used when no git tags present (fresh clone, CI).
 tag-pattern = "^(?:v)?(?P<version>\\d+\\.\\d+\\.\\d+)$"

{datafun_streaming-0.1.0 → datafun_streaming-0.2.0}/src/datafun_streaming/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.1.0'
-__version_tuple__ = version_tuple = (0, 1, 0)
+__version__ = version = '0.2.0'
+__version_tuple__ = version_tuple = (0, 2, 0)
 
 __commit_id__ = commit_id = None

datafun_streaming-0.1.0/README.md

@@ -1,129 +0,0 @@
-# datafun-streaming
-
-[![Adaptive Interfaces](https://img.shields.io/badge/adaptive--interfaces-schema-blue?logo=github)](https://github.com/denisecase)
-[![PyPI](https://img.shields.io/pypi/v/datafun-streaming?logo=pypi&label=pypi)](https://pypi.org/project/datafun-streaming/)
-[![Docs Site](https://img.shields.io/badge/docs-site-blue?logo=github)](https://denisecase.github.io/datafun-streaming/)
-[![Repo](https://img.shields.io/badge/repo-GitHub-black?logo=github)](https://github.com/denisecase/datafun-streaming)
-[![Python 3.15+](https://img.shields.io/badge/python-3.15%2B-blue?logo=python)](https://github.com/denisecase/datafun-streaming/blob/main/pyproject.toml)
-[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
-
-[![CI](https://github.com/denisecase/datafun-streaming/actions/workflows/ci-python-zensical.yml/badge.svg?branch=main)](https://github.com/denisecase/datafun-streaming/actions/workflows/ci-python-zensical.yml)
-[![Docs](https://github.com/denisecase/datafun-streaming/actions/workflows/deploy-zensical.yml/badge.svg?branch=main)](https://github.com/denisecase/datafun-streaming/actions/workflows/deploy-zensical.yml)
-[![Links](https://github.com/denisecase/datafun-streaming/actions/workflows/links.yml/badge.svg?branch=main)](https://github.com/denisecase/datafun-streaming/actions/workflows/links.yml)
-
-> Shared Python utilities for Kafka, DuckDB, validation, stats, and visualization
-> across streaming data analytics projects.
-
-## Command Reference
-
-<details>
-<summary>Show command reference</summary>
-
-### In a machine terminal
-
-Open a machine terminal where you want the project:
-
-```shell
-git clone https://github.com/denisecase/datafun-streaming
-
-cd datafun-streaming
-code .
-```
-
-### In a VS Code terminal
-
-```shell
-# reset uv cache only after suspected cache corruption or strange dependency errors
-# uv cache clean
-
-uv self update
-uv python pin 3.14
-uv sync --extra dev --extra docs --upgrade
-
-uvx pre-commit install
-
-git add -A
-uvx pre-commit run --all-files
-# repeat if changes were made
-git add -A
-uvx pre-commit run --all-files
-
-# do chores
-uv run python -m ruff format .
-uv run python -m ruff check . --fix
-uv run python -m pyright
-uv run python -m pytest
-uv run python -m zensical build
-
-# save progress
-git add -A
-git commit -m "update"
-git push -u origin main
-```
-
-</details>
-
-## Notes
-
-- Use the **UP ARROW** and **DOWN ARROW** in the terminal to scroll through past commands.
-- Use `CTRL+f` to find (and replace) text within a file.
-- You do not need to add to or modify `tests/`. They are provided for example only.
-- Many files are silent helpers. Explore as you like, but nothing is required.
-- You do NOT not to understand everything; understanding builds naturally over time.
-
-## Troubleshooting >>> or
-
-If you see something like this in your terminal: `>>>` or `...`
-You accidentally started Python interactive mode.
-It happens.
-Press `Ctrl+c` (both keys together) or `Ctrl+Z` then `Enter` on Windows.
-
-## Example Output
-
-```shell
-| INFO | P01 | ========================
-| INFO | P01 | START main()
-| INFO | P01 | ========================
-| INFO | P01 | ROOT_DIR = .
-| INFO | P01 | DATA_DIR = data
-| INFO | P01 | OUTPUT_CSV = data\sales.csv
-| INFO | P01 | Streaming 3 sales to C:\Repos\streaming\datafun-streaming\data\sales.csv ...
-| INFO | P01 | Watch each sale arrive. Press CTRL+C to stop early.
-
-| INFO | P01 | (1, 81.87, 'Backpack', 'East')
-| INFO | P01 | Generated formatted multi-line SUMMARY string.
-| INFO | P01 | Returning the str to the calling function.
-| INFO | P01 |
-    Descriptive Statistics for Streaming Sales Amounts ($):
-        Count of sales   : 1
-        Minimum sale     : $81.87
-        Maximum sale     : $81.87
-        Average sale     : $81.87
-        Standard deviation: $0.00
-
-| INFO | P01 | (2, 101.58, 'Water Bottle', 'North')
-| INFO | P01 | Generated formatted multi-line SUMMARY string.
-| INFO | P01 | Returning the str to the calling function.
-| INFO | P01 |
-    Descriptive Statistics for Streaming Sales Amounts ($):
-        Count of sales   : 2
-        Minimum sale     : $81.87
-        Maximum sale     : $101.58
-        Average sale     : $91.72
-        Standard deviation: $13.94
-
-| INFO | P01 | (3, 27.15, 'Running Shoes', 'East')
-| INFO | P01 | Generated formatted multi-line SUMMARY string.
-| INFO | P01 | Returning the str to the calling function.
-| INFO | P01 |
-    Descriptive Statistics for Streaming Sales Amounts ($):
-        Count of sales   : 3
-        Minimum sale     : $27.15
-        Maximum sale     : $101.58
-        Average sale     : $70.20
-        Standard deviation: $38.56
-
-| INFO | P01 | ========================
-| INFO | P01 | Producer executed successfully!
-| INFO | P01 | ========================
-```