featuresmith-core 0.1.0__py3-none-any.whl

featuresmith/rules/outliers.py

@@ -0,0 +1,113 @@
+"""Rule for detecting numeric outliers using the Interquartile Range (IQR) method."""
+
+from __future__ import annotations
+
+from featuresmith.core.profile_result import ProfileResult
+from featuresmith.core.rule_finding import RuleFinding
+from featuresmith.rules.base import BaseRule
+
+
+class OutlierDetectionRule(BaseRule):
+    """Flags numeric columns that contain values outside the IQR bounds [Q1 - 1.5*IQR, Q3 + 1.5*IQR]."""
+
+    def __init__(self, factor: float = 1.5) -> None:
+        """Initialize the outlier detection rule.
+
+        Args:
+            factor: The IQR multiplier (default 1.5).
+        """
+        self.factor = factor
+
+    @property
+    def id(self) -> str:
+        return "statistical.outliers"
+
+    @property
+    def name(self) -> str:
+        return "Outlier Detection"
+
+    @property
+    def description(self) -> str:
+        return (
+            "Detects columns containing numeric outliers outside "
+            "the standard IQR boundaries."
+        )
+
+    @property
+    def category(self) -> str:
+        return "statistical"
+
+    @property
+    def severity(self) -> str:
+        return "warning"
+
+    @property
+    def enabled_by_default(self) -> bool:
+        return True
+
+    def evaluate(self, profile: ProfileResult) -> list[RuleFinding]:
+        findings: list[RuleFinding] = []
+
+        for col_name, num_prof in profile.numeric_profiles.items():
+            q1 = num_prof.q1
+            q3 = num_prof.q3
+            iqr = num_prof.iqr
+            minimum = num_prof.minimum
+            maximum = num_prof.maximum
+
+            if (
+                q1 is not None
+                and q3 is not None
+                and iqr is not None
+                and minimum is not None
+                and maximum is not None
+            ):
+                lower_bound = q1 - self.factor * iqr
+                upper_bound = q3 + self.factor * iqr
+
+                has_lower_outliers = minimum < lower_bound
+                has_upper_outliers = maximum > upper_bound
+
+                if has_lower_outliers or has_upper_outliers:
+                    # Collect evidence
+                    exceeded_bounds = []
+                    if has_lower_outliers:
+                        exceeded_bounds.append(
+                            f"minimum ({minimum}) < lower bound ({lower_bound:.2f})"
+                        )
+                    if has_upper_outliers:
+                        exceeded_bounds.append(
+                            f"maximum ({maximum}) > upper bound ({upper_bound:.2f})"
+                        )
+
+                    exceeded_str = " and ".join(exceeded_bounds)
+
+                    findings.append(
+                        RuleFinding(
+                            rule_id=self.id,
+                            rule_name=self.name,
+                            category=self.category,
+                            severity=self.severity,
+                            column_name=col_name,
+                            title=f"Outliers detected in column '{col_name}'",
+                            description=(
+                                f"Column '{col_name}' contains values exceeding IQR bounds. "
+                                f"Triggered by: {exceeded_str}."
+                            ),
+                            evidence={
+                                "minimum": minimum,
+                                "maximum": maximum,
+                                "q1": q1,
+                                "q3": q3,
+                                "iqr": iqr,
+                                "lower_bound": lower_bound,
+                                "upper_bound": upper_bound,
+                                "factor": self.factor,
+                                "has_lower_outliers": has_lower_outliers,
+                                "has_upper_outliers": has_upper_outliers,
+                            },
+                            confidence=1.0,
+                        )
+                    )
+
+        return findings

featuresmith/rules/registry.py

@@ -0,0 +1,81 @@
+"""Explicit rule registry for Featuresmith rules."""
+
+from __future__ import annotations
+
+from collections.abc import Iterable
+
+from featuresmith.rules.base import BaseRule
+
+
+class RuleRegistry:
+    """Registry that holds all available rules for analysis execution.
+
+    Registration is kept explicit and static in this phase.
+    """
+
+    def __init__(self, rules: Iterable[BaseRule] = ()) -> None:
+        """Initialize registry with a set of initial rules."""
+        self._rules: dict[str, BaseRule] = {}
+        for rule in rules:
+            self.register(rule)
+
+    def register(self, rule: BaseRule) -> None:
+        """Register a new rule instance.
+
+        Args:
+            rule: An instance of a rule subclassing BaseRule.
+        """
+        self._rules[rule.id] = rule
+
+    def unregister(self, rule: BaseRule | str) -> None:
+        """Unregister a rule by instance or ID.
+
+        Args:
+            rule: The rule instance or rule ID to unregister.
+        """
+        rule_id = rule if isinstance(rule, str) else rule.id
+        if rule_id in self._rules:
+            del self._rules[rule_id]
+
+    def list_rules(self) -> list[BaseRule]:
+        """List all currently registered rules.
+
+        Returns:
+            A list of registered rule instances.
+        """
+        return list(self._rules.values())
+
+    def get(self, rule_id: str) -> BaseRule | None:
+        """Retrieve a registered rule by its ID.
+
+        Args:
+            rule_id: The ID of the rule.
+
+        Returns:
+            The registered BaseRule instance, or None if not found.
+        """
+        return self._rules.get(rule_id)
+
+
+def default_registry() -> RuleRegistry:
+    """Return the default RuleRegistry loaded with the 8 seed rules."""
+    from featuresmith.rules.cardinality import HighCardinalityRule
+    from featuresmith.rules.constants import ConstantColumnsRule, FullyEmptyColumnsRule
+    from featuresmith.rules.correlation import HighCorrelationRule
+    from featuresmith.rules.duplicates import DuplicateRowsRule
+    from featuresmith.rules.leakage import LeakageRuleTargetCorrelation
+    from featuresmith.rules.missing import MissingValueThresholdRule
+    from featuresmith.rules.outliers import OutlierDetectionRule
+
+    return RuleRegistry(
+        (
+            MissingValueThresholdRule(),
+            DuplicateRowsRule(),
+            ConstantColumnsRule(),
+            FullyEmptyColumnsRule(),
+            HighCardinalityRule(),
+            OutlierDetectionRule(),
+            HighCorrelationRule(),
+            LeakageRuleTargetCorrelation(),
+        )
+    )

featuresmith_core-0.1.0.dist-info/METADATA

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: featuresmith-core
+Version: 0.1.0
+Summary: Deterministic tabular data profiling and quality-rule engine.
+Author: Featuresmith contributors
+Maintainer: Featuresmith contributors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/adityagangwani30/FeatureSmith
+Project-URL: Documentation, https://featuresmith.adityagangwani.me
+Project-URL: Repository, https://github.com/adityagangwani30/FeatureSmith
+Project-URL: Issues, https://github.com/adityagangwani30/FeatureSmith/issues
+Project-URL: Changelog, https://github.com/adityagangwani30/FeatureSmith/blob/main/CHANGELOG.md
+Keywords: data-quality,feature-engineering,profiling,tabular-data
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: openpyxl~=3.1
+Requires-Dist: pandas~=2.2
+Requires-Dist: polars~=1.30
+Dynamic: license-file
+
+# featuresmith-core
+
+`featuresmith-core` is the public Python SDK and deterministic analysis engine for Featuresmith.
+
+It provides:
+
+- `featuresmith.load()` for local CSV, Excel, Parquet, pandas, and Polars sources.
+- `featuresmith.profile()` for reproducible tabular profiling.
+- `featuresmith.analyze()` for data quality and leakage rule findings.
+- Typed, serializable result dataclasses and a PEP 561 `py.typed` marker.
+
+Install featuresmith-core directly from PyPI:
+
+```bash
+pip install featuresmith-core
+```
+
+For comprehensive guides and API reference, visit the official website:
+<https://featuresmith.adityagangwani.me>

featuresmith_core-0.1.0.dist-info/RECORD

@@ -0,0 +1,45 @@
+featuresmith/__init__.py,sha256=eOCArpNZ7uQFGWAa6KE30aKdc-2DZ6LiWz8bZbzwBiw,151
+featuresmith/api.py,sha256=T3lqCbYJXlqLOft4nb8ORAGd0LeelohOaFkHuS7bwKE,6518
+featuresmith/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
+featuresmith/connectors/__init__.py,sha256=63nFvTrEbZ-a3PoM6GVCLJFJQq6HHwVnsgDPe_nCvaw,632
+featuresmith/connectors/_paths.py,sha256=sOyPn4TcK3PDqWc1wkRxVPjDMxdIxyqHFIj_M4mX41Q,912
+featuresmith/connectors/base.py,sha256=dFgOxCCfC7uiIzFHTA9AMliMg6NQBi1CcxlLF1-yeXE,1588
+featuresmith/connectors/csv_connector.py,sha256=U6aX5PRci-mxI-RYip66a3r61BSoO4zMqPUaSPAtmoY,1467
+featuresmith/connectors/dataframe_connector.py,sha256=D54Zdq1r1HDYZ6MtMiYlgn8A9qwWBifHCpjFxai-SL8,1501
+featuresmith/connectors/excel_connector.py,sha256=xf9xC6Aqxa1eJU2oDVYKkK2D5kkf4mCpMBASGzeOgP4,1566
+featuresmith/connectors/parquet_connector.py,sha256=4uyLQN9c6GFDzJsG8eSFwhBBtL4IGr4_EZR0vWkJSTk,1513
+featuresmith/connectors/registry.py,sha256=vSecsJHje1XUTHy8kbiGm4urZIOMRugDVYDyFNL3paY,2026
+featuresmith/core/__init__.py,sha256=UL0LowJc_BRf_7ftyex5DEELLJGptwVuOt3hgrAlknk,1194
+featuresmith/core/dataset.py,sha256=3sub2VjDGuP_JubP9SmYKMnDQ31-Rm76HYAUI1N0ETY,3891
+featuresmith/core/exceptions.py,sha256=r6a_B5cLxouS3cdEn5uCqT96Oy7jGuBn4qNyXhpKbjg,514
+featuresmith/core/profile_result.py,sha256=GnsKbM2-FlPzB-iZwdyWkp8Siquznexs2ymV7FGffGc,13857
+featuresmith/core/rule_finding.py,sha256=dUSJg2-gLHdb_KBm9pj2xc9rUMt4Eq2JYURmX51DAos,1763
+featuresmith/core/rule_result.py,sha256=nCKA7hw-8lb6pKBe6sCxDLu1hW-uaz7HvZ7Re-z6H3E,1798
+featuresmith/core/schema.py,sha256=I2UYqx2ltzbjpQRpnDPiXe79uygmWbGeHKByeF1PPO4,854
+featuresmith/profiling/__init__.py,sha256=O0doEusKFtiEWO--tQvMWRX2hHrwNcDTACzWeloTfC0,134
+featuresmith/profiling/categorical.py,sha256=EWgmxO4vqREbNfoZCNOekATWjjZjBeVXCRpu9s01y20,3614
+featuresmith/profiling/correlation.py,sha256=7JMZP7C67NgVvJHPnrdDXHLsNJt4Svb5TOpxHgbeBUw,2120
+featuresmith/profiling/datetime.py,sha256=mXFLU4y7j_TFB2KJuJi5_BYpfSYpE3TXYdDha7vijMY,3420
+featuresmith/profiling/duplicates.py,sha256=EV9Az50A60JzYgYrkaccdndsnUawNia9lwHE8JrArxA,1552
+featuresmith/profiling/missing.py,sha256=GRNhfFUtWhProWJH_rh2WU4qqHM9FOspFayazSLWL_c,2541
+featuresmith/profiling/numeric.py,sha256=BOYJbsiJWV7wDACYc3UPEGMlAXJqTKT9iTzmrrcUYi4,7940
+featuresmith/profiling/profiler.py,sha256=C6CyQF1X_rS-r5CMP9Z3MLHu_S8LIKH86CuHmWc9QWI,7970
+featuresmith/profiling/quality.py,sha256=7hwgssRQNXg1oljVpDiOFCjqSYzO70lE7OU5v3TjUpU,876
+featuresmith/profiling/summary.py,sha256=4yUBhYu0dposoN2n6ssp5a5U3kULTqcVTLIt78IHwQU,3516
+featuresmith/profiling/text.py,sha256=exrZQ3GIgffMjBkYk9Ilr59nnoozggz_6bb24PaKcUY,3689
+featuresmith/rules/__init__.py,sha256=SgcdBUilfoR7sKf-duxUuiUjBVSBhJWf5bxrv9pIlmg,1026
+featuresmith/rules/base.py,sha256=Oz14G9tYXUeHbyM57fyh75e9wXsUgulX2vU9kIUjM9c,1969
+featuresmith/rules/cardinality.py,sha256=EGiMLCLb2fvn_kvqz9EFbeZWs26OMCzUCxlPcga_NY4,3828
+featuresmith/rules/constants.py,sha256=rL46jr7edthhMRvwDRhShUg23LspnYexhvJK07epTn0,3628
+featuresmith/rules/correlation.py,sha256=j6mQSHpNKhb6CS2GTJHU1xBggtohrRktOCji8Q68I3s,2725
+featuresmith/rules/duplicates.py,sha256=EJwrjAlxOeeY2qzpBOFLop0mh8eURUYp4Xm-yKZ2auw,2493
+featuresmith/rules/engine.py,sha256=q7FatVTzSUHUDiQwb4dO53EbrYkTW2dVcbhTwMbbww4,6427
+featuresmith/rules/leakage.py,sha256=hoHyDP1wTfqu2-ZmVadlkQE_71_hivP1dkZm6SSI_Wo,3268
+featuresmith/rules/missing.py,sha256=ECyxJRPM1UNhqlsavwrVBjYhdT1cSRU1RmqONZuhfqU,2896
+featuresmith/rules/outliers.py,sha256=k96jxQx6cztz6S9WE1DgLOryCUo0jf-_QPS7-orw_8o,3980
+featuresmith/rules/registry.py,sha256=Z4Jw2ZDImx2GB3kumfWKNV2tGk-0BmyGHkfpEhRJI9w,2574
+featuresmith_core-0.1.0.dist-info/licenses/LICENSE,sha256=2V-SV_he4Wbt1eOFT_xNw6GpJOToqbH9L_8OJSSHUO0,10491
+featuresmith_core-0.1.0.dist-info/METADATA,sha256=lVxBswvWg6fHrhXt8zxZsiTklBOk7uYRvc2n-5pKORQ,1999
+featuresmith_core-0.1.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+featuresmith_core-0.1.0.dist-info/top_level.txt,sha256=hE4zEJ2obKUuFLmvREby9NRxw06tcrnz03UQlV1SATs,13
+featuresmith_core-0.1.0.dist-info/RECORD,,

featuresmith_core-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

featuresmith_core-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,187 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as defined by Sections 2(b), any work of
+      authorship, including the original version of the Work and any
+      modifications or additions to that Work or Derivative Works of the Work,
+      that is intentionally submitted to the Licensor for inclusion in the Work
+      by the copyright owner or by an individual or Legal Entity authorized to
+      submit on behalf of the copyright owner. For the purposes of this
+      definition, "submitted" means any form of electronic, verbal, or written
+      communication sent to the Licensor or its representatives, including but
+      not limited to communication on electronic mailing lists, source code
+      control systems, and issue tracking systems that are managed by, or on
+      behalf of, the Licensor for the purpose of discussing and improving the
+      Work, but excluding communication that is conspicuously marked or
+      otherwise designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and subsequently
+      incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or as an addendum to
+          the NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the
+          License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Contribution, either on its own or as part of the Work.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Featuresmith Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

featuresmith_core-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+featuresmith