dataxid-profiling 0.1.0__tar.gz

dataxid_profiling-0.1.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @dataxid/core-maintainers

dataxid_profiling-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug Report
+about: Report a bug in dataxid-profiling
+labels: bug
+---
+
+## Description
+
+A clear description of the bug.
+
+## Steps to Reproduce
+
+```python
+import polars as pl
+from dataxid_profiling import ProfileReport
+
+# minimal code to reproduce
+```
+
+## Expected Behavior
+
+What you expected to happen.
+
+## Actual Behavior
+
+What actually happened. Include the full error traceback if applicable.
+
+## Environment
+
+- **dataxid-profiling version**: `pip show dataxid-profiling`
+- **polars version**: `pip show polars`
+- **Python version**: `python --version`
+- **OS**:

dataxid_profiling-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature Request
+about: Suggest an improvement or new feature
+labels: enhancement
+---
+
+## Problem
+
+What problem does this solve? Why is it needed?
+
+## Proposed Solution
+
+How should it work? Include a code example if possible:
+
+```python
+# how you'd like to use it
+```
+
+## Alternatives Considered
+
+Any alternative approaches you've thought about.

dataxid_profiling-0.1.0/.github/pull_request_template.md

@@ -0,0 +1,17 @@
+## What
+
+Brief description of the change.
+
+## Why
+
+Motivation — what problem does this solve?
+
+## How
+
+Key implementation decisions (if non-obvious).
+
+## Test Plan
+
+- [ ] Existing tests pass (`pytest tests/`)
+- [ ] New tests added (if applicable)
+- [ ] Tested manually with a sample dataset

dataxid_profiling-0.1.0/.gitignore

@@ -0,0 +1,35 @@
+# Local docs
+.local/
+
+# Python
+__pycache__/
+*.py[cod]
+*.so
+*.egg-info/
+dist/
+build/
+
+# Virtual environment
+.venv/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.mypy_cache/
+
+# Reports
+reports/
+
+# Jupyter
+.ipynb_checkpoints/

dataxid_profiling-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

dataxid_profiling-0.1.0/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/),
+and this project adheres to [Semantic Versioning](https://semver.org/).
+
+## [0.1.0] - 2026-03-23
+
+### Added
+
+- `ProfileReport` — 3-line data profiling for Polars and Pandas DataFrames
+- 5 column analyzers: numeric, categorical, boolean, datetime, text
+- Dataset overview: row/column counts, missing totals, duplicate rows, memory usage, type distribution
+- 7 data quality alerts: HIGH_MISSING, CONSTANT, HIGH_CARDINALITY, DUPLICATES, HIGH_ZEROS, SKEWED, IMBALANCED
+- Pearson correlation heatmap (Polars-native)
+- Interactive HTML report with ECharts (histogram, bar, pie, word cloud, heatmap)
+- Programmatic access: `to_dict()`, `to_json()`, `.stats`, `.alerts`, `.correlations`
+- Two profiling modes: `"complete"` (deep analysis) and `"overview"` (fast summary)
+- Pandas auto-conversion via `pl.from_pandas()`
+- CSV and Parquet file path ingestion
+- PEP 561 `py.typed` marker
+
+[0.1.0]: https://github.com/dataxid/dataxid-profiling/releases/tag/v0.1.0

dataxid_profiling-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing to dataxid-profiling
+
+Thanks for your interest in contributing! Here's how to get started.
+
+## Development Setup
+
+```bash
+git clone https://github.com/dataxid/dataxid-profiling.git
+cd dataxid-profiling
+uv sync
+```
+
+## Running Tests
+
+```bash
+pytest
+```
+
+## Linting
+
+```bash
+ruff check src/ tests/
+ruff format src/ tests/
+```
+
+## Code Style
+
+- Line length: 99 characters
+- Type hints everywhere, `Any` only for opaque state
+- Minimal comments — code should be self-explanatory, comments explain *why*, not *what*
+- Import order: stdlib → third-party → project (enforced by `ruff`)
+- Polars-native: no NumPy/SciPy/Pandas in core logic
+
+## Pull Requests
+
+1. Fork the repo and create a feature branch
+2. Make your changes with tests
+3. Run `ruff check` and `pytest` before submitting
+4. Open a PR with a clear description of what and why
+
+## Reporting Issues
+
+Use [GitHub Issues](https://github.com/dataxid/dataxid-profiling/issues) with the provided templates.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the Apache License 2.0.

dataxid_profiling-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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, whether in Source or
+      Object form, 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 any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to 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 individual or Legal Entity
+      on behalf of whom a Contribution has been received by 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, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, 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 copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   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 consequential 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 any and 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

dataxid_profiling-0.1.0/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.4
+Name: dataxid-profiling
+Version: 0.1.0
+Summary: Fast, Polars-native data profiling with interactive HTML reports and data quality alerts.
+Project-URL: Homepage, https://dataxid.com
+Project-URL: Repository, https://github.com/dataxid/dataxid-profiling
+Project-URL: Changelog, https://github.com/dataxid/dataxid-profiling/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/dataxid/dataxid-profiling/issues
+Author-email: DataXID <dev@dataxid.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: data-profiling,data-quality,eda,exploratory-data-analysis,pandas-profiling,polars,profiling,ydata-profiling
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: jinja2>=3.1
+Requires-Dist: polars>=1.0
+Description-Content-Type: text/markdown
+
+# dataxid-profiling
+
+[![PyPI version](https://img.shields.io/pypi/v/dataxid-profiling.svg)](https://pypi.org/project/dataxid-profiling/)
+[![Python versions](https://img.shields.io/pypi/pyversions/dataxid-profiling.svg)](https://pypi.org/project/dataxid-profiling/)
+[![License](https://img.shields.io/pypi/l/dataxid-profiling.svg)](https://github.com/dataxid/dataxid-profiling/blob/main/LICENSE)
+
+Fast, Polars-native data profiling with interactive HTML reports and data quality alerts.
+
+## Quickstart
+
+```python
+import polars as pl
+from dataxid_profiling import ProfileReport
+
+df = pl.read_csv("data.csv")
+report = ProfileReport(df)
+report.to_html("report.html")
+```
+
+Pandas works too:
+
+```python
+report = ProfileReport(pd.read_csv("data.csv"))
+```
+
+## Report Preview
+
+**Dataset overview** — row/column counts, missing cells, duplicates, memory usage, and column type distribution at a glance.
+
+<p align="center">
+  <img src="docs/report-overview.png" alt="Dataset overview and alerts" width="700">
+</p>
+
+**Column details** — per-column statistics, top value distribution, and word clouds for categorical data.
+
+<p align="center">
+  <img src="docs/report-columns.png" alt="Column details with charts and word cloud" width="700">
+</p>
+
+**Correlations** — interactive heatmap showing relationships between numeric columns.
+
+<p align="center">
+  <img src="docs/report-correlations.png" alt="Correlation heatmap" width="700">
+</p>
+
+## Highlights
+
+- Built on Polars — two runtime dependencies
+- 3 lines to profile any dataset
+- Programmatic-first: `.to_dict()`, `.stats`, `.alerts`
+- Interactive HTML reports with ECharts
+- Accepts Polars, Pandas, CSV, and Parquet
+- 5 column types: numeric, categorical, boolean, datetime, text
+- 7 data quality alerts out of the box
+- Pearson correlation heatmap
+- Two modes: `"complete"` for deep analysis, `"overview"` for speed
+- Fully typed
+
+## Installation
+
+```bash
+pip install dataxid-profiling
+```
+
+## Usage
+
+### Programmatic access
+
+```python
+report = ProfileReport(df, title="Customer Data Profile")
+
+stats = report.to_dict()
+alerts = report.alerts
+column_stats = report.stats["age"]
+correlations = report.correlations
+```
+
+### JSON export
+
+```python
+report.to_json("report.json")
+```
+
+### Configuration
+
+```python
+from dataxid_profiling import ProfileReport, ProfileConfig
+
+config = ProfileConfig(
+    title="Customer Data Profile",
+    mode="overview",
+    missing_threshold=0.1,
+    histogram_bins=30,
+)
+report = ProfileReport(df, config=config)
+```
+
+### Modes
+
+| Feature | `"complete"` | `"overview"` |
+|---|:-:|:-:|
+| Basic stats | ✓ | ✓ |
+| Histograms & value counts | ✓ | ✓ |
+| Correlations | ✓ | ✗ |
+| Character analysis | ✓ | ✗ |
+| Duplicate rows table | ✓ | ✗ |
+
+## Output formats
+
+| Format | Method | Use case |
+|---|---|---|
+| HTML | `report.to_html("report.html")` | Interactive report |
+| JSON | `report.to_json("report.json")` | Machine-readable |
+| Dict | `report.to_dict()` | Python-native |
+
+## Contributing
+
+Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+## Links
+
+- [PyPI](https://pypi.org/project/dataxid-profiling/)
+- [Changelog](CHANGELOG.md)
+- [GitHub Issues](https://github.com/dataxid/dataxid-profiling/issues)
+
+## License
+
+[Apache-2.0](LICENSE)

dataxid_profiling-0.1.0/README.md

@@ -0,0 +1,128 @@
+# dataxid-profiling
+
+[![PyPI version](https://img.shields.io/pypi/v/dataxid-profiling.svg)](https://pypi.org/project/dataxid-profiling/)
+[![Python versions](https://img.shields.io/pypi/pyversions/dataxid-profiling.svg)](https://pypi.org/project/dataxid-profiling/)
+[![License](https://img.shields.io/pypi/l/dataxid-profiling.svg)](https://github.com/dataxid/dataxid-profiling/blob/main/LICENSE)
+
+Fast, Polars-native data profiling with interactive HTML reports and data quality alerts.
+
+## Quickstart
+
+```python
+import polars as pl
+from dataxid_profiling import ProfileReport
+
+df = pl.read_csv("data.csv")
+report = ProfileReport(df)
+report.to_html("report.html")
+```
+
+Pandas works too:
+
+```python
+report = ProfileReport(pd.read_csv("data.csv"))
+```
+
+## Report Preview
+
+**Dataset overview** — row/column counts, missing cells, duplicates, memory usage, and column type distribution at a glance.
+
+<p align="center">
+  <img src="docs/report-overview.png" alt="Dataset overview and alerts" width="700">
+</p>
+
+**Column details** — per-column statistics, top value distribution, and word clouds for categorical data.
+
+<p align="center">
+  <img src="docs/report-columns.png" alt="Column details with charts and word cloud" width="700">
+</p>
+
+**Correlations** — interactive heatmap showing relationships between numeric columns.
+
+<p align="center">
+  <img src="docs/report-correlations.png" alt="Correlation heatmap" width="700">
+</p>
+
+## Highlights
+
+- Built on Polars — two runtime dependencies
+- 3 lines to profile any dataset
+- Programmatic-first: `.to_dict()`, `.stats`, `.alerts`
+- Interactive HTML reports with ECharts
+- Accepts Polars, Pandas, CSV, and Parquet
+- 5 column types: numeric, categorical, boolean, datetime, text
+- 7 data quality alerts out of the box
+- Pearson correlation heatmap
+- Two modes: `"complete"` for deep analysis, `"overview"` for speed
+- Fully typed
+
+## Installation
+
+```bash
+pip install dataxid-profiling
+```
+
+## Usage
+
+### Programmatic access
+
+```python
+report = ProfileReport(df, title="Customer Data Profile")
+
+stats = report.to_dict()
+alerts = report.alerts
+column_stats = report.stats["age"]
+correlations = report.correlations
+```
+
+### JSON export
+
+```python
+report.to_json("report.json")
+```
+
+### Configuration
+
+```python
+from dataxid_profiling import ProfileReport, ProfileConfig
+
+config = ProfileConfig(
+    title="Customer Data Profile",
+    mode="overview",
+    missing_threshold=0.1,
+    histogram_bins=30,
+)
+report = ProfileReport(df, config=config)
+```
+
+### Modes
+
+| Feature | `"complete"` | `"overview"` |
+|---|:-:|:-:|
+| Basic stats | ✓ | ✓ |
+| Histograms & value counts | ✓ | ✓ |
+| Correlations | ✓ | ✗ |
+| Character analysis | ✓ | ✗ |
+| Duplicate rows table | ✓ | ✗ |
+
+## Output formats
+
+| Format | Method | Use case |
+|---|---|---|
+| HTML | `report.to_html("report.html")` | Interactive report |
+| JSON | `report.to_json("report.json")` | Machine-readable |
+| Dict | `report.to_dict()` | Python-native |
+
+## Contributing
+
+Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+## Links
+
+- [PyPI](https://pypi.org/project/dataxid-profiling/)
+- [Changelog](CHANGELOG.md)
+- [GitHub Issues](https://github.com/dataxid/dataxid-profiling/issues)
+
+## License
+
+[Apache-2.0](LICENSE)