DataExcept 0.2.0__tar.gz → 0.2.1__tar.gz

{dataexcept-0.2.0 → dataexcept-0.2.1}/CHANGELOG.md

@@ -7,6 +7,38 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.1] - 2026-08-24
+
+Documentation and CLI fixes. 0.2.0's README is what PyPI renders as the
+project description, and its quick-start example did not run.
+
+### Fixed
+
+- `python -m dataexcept --version` reported `__main__.py` as the program name
+  instead of `dataexcept`, because argparse defaults `prog` to `sys.argv[0]`.
+- `dataexcept list` imported the deprecated `job_exceptions` shim to build its
+  output, so it emitted a `DeprecationWarning` at anyone who merely wanted to
+  see what the package offers, and it advertised `ConnectionError` and
+  `TimeoutError` alongside their replacements. Deprecated modules are now
+  skipped; the listing is 98 names, matching the classes the package defines.
+- README's quick-start example began `from dataexcept import ValidationError,
+  ModelTrainingError`, which raises `ImportError` — `ModelTrainingError` is in
+  `dataexcept.datascience_exceptions` and is not re-exported at the top level.
+- `docs/advanced_usage.md` taught `from dataexcept.job_exceptions import
+  JobError`, the deprecated path.
+- README's comparison table showed exception messages without the
+  `[ClassName]` prefix the classes actually emit, its sample `dataexcept list`
+  output did not match the real alphabetical listing, its exception count and
+  CLI version were stale, and its end-to-end example used `np.log` without
+  importing numpy.
+
+### Added
+
+- Tests that read the documentation: every `from dataexcept... import ...` in
+  README and `docs/` must resolve, no example may import a deprecated module,
+  and the README's exception count must match the package. Checked that these
+  fail when the original defects are reintroduced.
+
 ## [0.2.0] - 2026-08-24
 
 ### Changed
@@ -62,6 +94,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `examples/example_usage.py` raised `TimeoutError` with keyword arguments the
   builtin does not accept — a live instance of the shadowing hazard.
 
+
 ## [0.1.0] - 2026-08-24
 
 First public release.
@@ -93,6 +126,7 @@ First public release.
 - Published to PyPI via OIDC trusted publishing; no long-lived API token is
   involved in a release.
 
-[Unreleased]: https://github.com/DiogoRibeiro7/DataExcept/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/DiogoRibeiro7/DataExcept/compare/v0.2.1...HEAD
+[0.2.1]: https://github.com/DiogoRibeiro7/DataExcept/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/DiogoRibeiro7/DataExcept/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/DiogoRibeiro7/DataExcept/releases/tag/v0.1.0

{dataexcept-0.2.0 → dataexcept-0.2.1}/CITATION.cff

@@ -1,7 +1,7 @@
 cff-version: 1.2.0
 message: "If you use this software, please cite it using the following metadata."
 title: "DataExcept"
-version: "0.2.0"
+version: "0.2.1"
 authors:
   - family-names: "Ribeiro"
     given-names: "Diogo"

{dataexcept-0.2.0 → dataexcept-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: DataExcept
-Version: 0.2.0
+Version: 0.2.1
 Summary: A Python package providing structured, easily-extendable custom exception types.
 License-Expression: MIT
 License-File: LICENSE
@@ -34,15 +34,15 @@ Description-Content-Type: text/markdown
 
 ❌ Without DataExcept            | ✅ With DataExcept
 ------------------------------- | -------------------------------------------------------------------------------------
-`ValueError: Invalid value`     | `DataValidationError: Invalid value for 'age': -1`
-`RuntimeError: Training failed` | `ConvergenceError: Model 'RandomForest' failed to converge after 100 iterations`
-`Exception: Prediction error`   | `ModelInferenceError: Inference failed for model 'CNN': CUDA out of memory`
-`KeyError: column not found`    | `MissingColumnError: Missing required column 'customer_id' in DataFrame 'sales_data'`
+`ValueError: Invalid value`     | `DataValidationError: [DataValidationError:age] Invalid value for 'age': -1`
+`RuntimeError: Training failed` | `ConvergenceError: [ConvergenceError] Model 'RandomForest' failed to converge after 100 iterations`
+`Exception: Prediction error`   | `ModelInferenceError: [ModelInferenceError:CNN] Inference failed for model 'CNN': CUDA out of memory`
+`KeyError: column not found`    | `MissingColumnError: [MissingColumnError] Missing required column 'customer_id' in DataFrame 'sales_data'`
 
 ## 🎯 Key Features
 
 - **🏗️ Hierarchical Structure**: Catch specific errors or broad categories
-- **📊 Data Science Focused**: 96 exception classes covering ML pipelines, feature engineering, model training
+- **📊 Data Science Focused**: 98 exception classes covering ML pipelines, feature engineering, model training
 - **🔧 Production Ready**: Comprehensive logging helpers and error context
 - **📚 Academic Quality**: Proper documentation, type hints, and citation support
 - **🐍 Python 3.10+**: Modern Python with full type safety
@@ -67,8 +67,8 @@ poetry install
 ### Basic Usage
 
 ```python
-from dataexcept import ValidationError, ModelTrainingError
-from dataexcept.datascience_exceptions import DataLoadingError
+from dataexcept import ValidationError
+from dataexcept.datascience_exceptions import DataLoadingError, ModelTrainingError
 import pandas as pd
 
 # Data validation with context
@@ -214,17 +214,18 @@ except Exception as exc:
 ### Command Line Interface
 
 ```bash
-# List all available exception classes
+# List every exception class the package exports (98 of them, alphabetically)
 $ dataexcept list
-JobError
-ValidationError
-DataScienceError
-ModelTrainingError
-... (40+ more)
+ApiError
+AuthenticationError
+AuthorizationError
+BatchProcessingError
+BiasDetectionError
+...
 
 # Check version
 $ dataexcept --version
-dataexcept 0.1.0
+dataexcept 0.2.1
 ```
 
 ## 🎯 Use Cases
@@ -255,6 +256,7 @@ dataexcept 0.1.0
 """
 Complete ML pipeline with DataExcept error handling
 """
+import numpy as np
 import pandas as pd
 from sklearn.ensemble import RandomForestClassifier
 from dataexcept import ValidationError
@@ -369,12 +371,12 @@ through [SECURITY.md](SECURITY.md), not the public issue tracker.
 If you use DataExcept in your research, please cite it:
 
 ```bibtex
-@software{ribeiro_dataexcept_2025,
+@software{ribeiro_dataexcept_2026,
   author = {Ribeiro, Diogo},
   title = {DataExcept: Structured Exception Handling for Data Science},
   url = {https://github.com/DiogoRibeiro7/DataExcept},
-  version = {0.1.0},
-  year = {2025},
+  version = {0.2.1},
+  year = {2026},
   publisher = {GitHub}
 }
 ```

{dataexcept-0.2.0 → dataexcept-0.2.1}/README.md

@@ -8,15 +8,15 @@
 
 ❌ Without DataExcept            | ✅ With DataExcept
 ------------------------------- | -------------------------------------------------------------------------------------
-`ValueError: Invalid value`     | `DataValidationError: Invalid value for 'age': -1`
-`RuntimeError: Training failed` | `ConvergenceError: Model 'RandomForest' failed to converge after 100 iterations`
-`Exception: Prediction error`   | `ModelInferenceError: Inference failed for model 'CNN': CUDA out of memory`
-`KeyError: column not found`    | `MissingColumnError: Missing required column 'customer_id' in DataFrame 'sales_data'`
+`ValueError: Invalid value`     | `DataValidationError: [DataValidationError:age] Invalid value for 'age': -1`
+`RuntimeError: Training failed` | `ConvergenceError: [ConvergenceError] Model 'RandomForest' failed to converge after 100 iterations`
+`Exception: Prediction error`   | `ModelInferenceError: [ModelInferenceError:CNN] Inference failed for model 'CNN': CUDA out of memory`
+`KeyError: column not found`    | `MissingColumnError: [MissingColumnError] Missing required column 'customer_id' in DataFrame 'sales_data'`
 
 ## 🎯 Key Features
 
 - **🏗️ Hierarchical Structure**: Catch specific errors or broad categories
-- **📊 Data Science Focused**: 96 exception classes covering ML pipelines, feature engineering, model training
+- **📊 Data Science Focused**: 98 exception classes covering ML pipelines, feature engineering, model training
 - **🔧 Production Ready**: Comprehensive logging helpers and error context
 - **📚 Academic Quality**: Proper documentation, type hints, and citation support
 - **🐍 Python 3.10+**: Modern Python with full type safety
@@ -41,8 +41,8 @@ poetry install
 ### Basic Usage
 
 ```python
-from dataexcept import ValidationError, ModelTrainingError
-from dataexcept.datascience_exceptions import DataLoadingError
+from dataexcept import ValidationError
+from dataexcept.datascience_exceptions import DataLoadingError, ModelTrainingError
 import pandas as pd
 
 # Data validation with context
@@ -188,17 +188,18 @@ except Exception as exc:
 ### Command Line Interface
 
 ```bash
-# List all available exception classes
+# List every exception class the package exports (98 of them, alphabetically)
 $ dataexcept list
-JobError
-ValidationError
-DataScienceError
-ModelTrainingError
-... (40+ more)
+ApiError
+AuthenticationError
+AuthorizationError
+BatchProcessingError
+BiasDetectionError
+...
 
 # Check version
 $ dataexcept --version
-dataexcept 0.1.0
+dataexcept 0.2.1
 ```
 
 ## 🎯 Use Cases
@@ -229,6 +230,7 @@ dataexcept 0.1.0
 """
 Complete ML pipeline with DataExcept error handling
 """
+import numpy as np
 import pandas as pd
 from sklearn.ensemble import RandomForestClassifier
 from dataexcept import ValidationError
@@ -343,12 +345,12 @@ through [SECURITY.md](SECURITY.md), not the public issue tracker.
 If you use DataExcept in your research, please cite it:
 
 ```bibtex
-@software{ribeiro_dataexcept_2025,
+@software{ribeiro_dataexcept_2026,
   author = {Ribeiro, Diogo},
   title = {DataExcept: Structured Exception Handling for Data Science},
   url = {https://github.com/DiogoRibeiro7/DataExcept},
-  version = {0.1.0},
-  year = {2025},
+  version = {0.2.1},
+  year = {2026},
   publisher = {GitHub}
 }
 ```

{dataexcept-0.2.0 → dataexcept-0.2.1}/dataexcept/__main__.py

@@ -12,9 +12,14 @@ from typing import Iterable
 from . import __path__ as _PKG_PATH
 from . import __version__
 
+#: Deprecated compatibility shims. Listing these would advertise names that are
+#: scheduled for removal, and importing them emits a DeprecationWarning at
+#: anyone who merely wanted to see what the package offers.
+_DEPRECATED_MODULES = frozenset({"dataexcept.job_exceptions"})
+
 
 def _iter_exception_modules() -> Iterable[ModuleType]:
-    """Yield every submodule that explicitly defines ``__all__``."""
+    """Yield every non-deprecated submodule that explicitly defines ``__all__``."""
     allowed_suffixes = ("exceptions", "_exceptions")
 
     for module_info in pkgutil.walk_packages(
@@ -22,6 +27,8 @@ def _iter_exception_modules() -> Iterable[ModuleType]:
     ):
         if not module_info.name.endswith(allowed_suffixes):
             continue
+        if module_info.name in _DEPRECATED_MODULES:
+            continue
         try:
             module = import_module(module_info.name)
         except ImportError as exc:  # pragma: no cover - defensive guard
@@ -53,7 +60,11 @@ def _list_exceptions() -> None:
 
 def main(argv: list[str] | None = None) -> None:
     """Entry point for the ``dataexcept`` command."""
-    parser = argparse.ArgumentParser(description="Utilities for DataExcept")
+    parser = argparse.ArgumentParser(
+        # Without this, `python -m dataexcept --version` reports "__main__.py".
+        prog="dataexcept",
+        description="Utilities for DataExcept",
+    )
     parser.add_argument(
         "--version",
         action="version",

{dataexcept-0.2.0 → dataexcept-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "DataExcept"
-version = "0.2.0"
+version = "0.2.1"
 description = "A Python package providing structured, easily-extendable custom exception types."
 readme = "README.md"
 license = "MIT"