chartrank 0.1.0__py3-none-any.whl

chartrank/__init__.py

@@ -0,0 +1,7 @@
+"""ChartRank: suggests and explains the right chart for your data and intent."""
+
+from chartrank.profile import profile
+
+__version__ = "0.1.0"
+
+__all__ = ["__version__", "profile"]

chartrank/catalog.py

@@ -0,0 +1,4 @@
+"""Chart catalog.
+
+Declarative table mapping (variable types, intent) to candidate charts.
+"""

chartrank/cli.py

@@ -0,0 +1 @@
+"""Command-line interface: profile, suggest and rank commands."""

chartrank/codegen.py

@@ -0,0 +1 @@
+"""Code generation: turn a ChartSpec into a standalone, commented Python script."""

chartrank/dictionary.py

@@ -0,0 +1,4 @@
+"""Data dictionary.
+
+Load and validate YAML or dict metadata (units, order, labels, roles).
+"""

chartrank/gallery.py

@@ -0,0 +1 @@
+"""Gallery: object returned by suggest(), with show(), best and indexing."""

chartrank/guards.py

@@ -0,0 +1,4 @@
+"""Guard rules.
+
+Best-practice checks (log scale, top N, overplotting...) applied to candidates.
+"""

chartrank/profile.py

@@ -0,0 +1,50 @@
+"""Column profiling: semantic types and indicators.
+
+Version 0.1 is minimal: for each column, its pandas dtype, the share of missing
+values and the number of distinct values. Semantic types come in task 1.1.
+"""
+
+import pandas as pd
+
+
+def profile(df: pd.DataFrame) -> pd.DataFrame:
+    """Describe each column of ``df``.
+
+    Args:
+        df: The data to describe. It is never modified.
+
+    Returns:
+        One row per column (same order as ``df``), with:
+
+        - ``dtype``: the pandas dtype, as text (e.g. ``"float64"``);
+        - ``missing``: share of missing values, between 0 and 1;
+        - ``distinct``: number of distinct non-missing values.
+
+    Raises:
+        TypeError: If ``df`` is not a pandas DataFrame.
+
+    Example:
+        >>> import pandas as pd
+        >>> import chartrank as cr
+        >>> cr.profile(pd.DataFrame({"Age": [22.0, None, 38.0, 22.0]}))
+               dtype  missing  distinct
+        Age  float64     0.25         2
+    """
+    if not isinstance(df, pd.DataFrame):
+        raise TypeError(
+            f"profile() expects a pandas DataFrame, got {type(df).__name__}. "
+            "Convert your data first, e.g. pd.DataFrame(data) or pd.read_csv(path)."
+        )
+
+    n_rows = len(df)
+    rows = {
+        column: {
+            "dtype": str(df[column].dtype),
+            "missing": df[column].isna().sum() / n_rows if n_rows else 0.0,
+            "distinct": df[column].nunique(dropna=True),
+        }
+        for column in df.columns
+    }
+    return pd.DataFrame.from_dict(
+        rows, orient="index", columns=["dtype", "missing", "distinct"]
+    )

chartrank/recommend.py

@@ -0,0 +1 @@
+"""Recommender: combines catalog and guards, ranks candidates, picks the star chart."""

chartrank/render/__init__.py

@@ -0,0 +1 @@
+"""Rendering backends that turn a ChartSpec into a figure."""

chartrank/render/plotly.py

@@ -0,0 +1 @@
+"""Plotly backend: ChartSpec to plotly.graph_objects.Figure, with the common theme."""

chartrank/spec.py

@@ -0,0 +1 @@
+"""ChartSpec: neutral, engine-independent description of a chart."""

chartrank/target.py

@@ -0,0 +1,4 @@
+"""Target analysis.
+
+Task detection and association measures between variables and a target.
+"""

chartrank-0.1.0.dist-info/METADATA

@@ -0,0 +1,75 @@
+Metadata-Version: 2.5
+Name: chartrank
+Version: 0.1.0
+Summary: Early preview, not ready for use. Suggests and explains the right chart for your data and intent.
+Project-URL: Homepage, https://github.com/Adeshinan/chartrank
+Project-URL: Issues, https://github.com/Adeshinan/chartrank/issues
+Project-URL: Changelog, https://github.com/Adeshinan/chartrank/blob/main/CHANGELOG.md
+Author: Faïd Adéshinan ALAGBE
+License-Expression: MIT
+License-File: LICENSE
+Keywords: chart-recommendation,data-visualization,eda,pandas,plotly
+Classifier: Development Status :: 2 - Pre-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.14
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: numpy>=1.26
+Requires-Dist: pandas>=2.2
+Requires-Dist: plotly>=5.24
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: mkdocs-material>=9.5; extra == 'dev'
+Requires-Dist: mkdocs-static-i18n>=1.2; extra == 'dev'
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pandas-stubs>=2.2; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest-socket>=0.7; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: twine>=6.0; extra == 'dev'
+Requires-Dist: types-pyyaml>=6.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
+Requires-Dist: mkdocs-static-i18n>=1.2; extra == 'docs'
+Provides-Extra: static
+Requires-Dist: kaleido>=1.0; extra == 'static'
+Description-Content-Type: text/markdown
+
+# ChartRank
+
+[![CI](https://github.com/Adeshinan/chartrank/actions/workflows/ci.yml/badge.svg)](https://github.com/Adeshinan/chartrank/actions/workflows/ci.yml)
+[![Docs](https://github.com/Adeshinan/chartrank/actions/workflows/docs.yml/badge.svg)](https://adeshinan.github.io/chartrank/)
+![Python](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+
+**Suggests and explains the right chart for your data and intent.**
+
+> 🚧 Work in progress — v1.0 planned for December 2026.
+
+Give ChartRank one or two columns and an intent (`compare`, `distribution`,
+`relationship`, `composition`, `trend`). It proposes 3 to 5 charts drawn on your
+own data, marks the recommended one with ★, explains each with numbers computed
+from your data ("good for / avoid if"), and gives you the image or a standalone
+Python script to reproduce it. Deterministic, local, no AI.
+
+```python
+import chartrank as cr
+
+g = cr.suggest(df, x="Pclass", y="Fare", intent="compare")
+g.show()
+print(g.best.why)
+print(g.best.code)
+```
+
+*This API is the v1.0 target and is not available yet.*
+
+[Documentation](https://adeshinan.github.io/chartrank/) ·
+[Version française](README.fr.md) · License: [MIT](LICENSE)

chartrank-0.1.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+chartrank/__init__.py,sha256=sks0q6A6YH-K6Y87_23p8IPK-Rm-0PIYS1XvjIwmw84,181
+chartrank/catalog.py,sha256=2Igf-JrKlv8P3zZWZrLzN5YM9ED_PIw4Fkzn1YjiYLU,95
+chartrank/cli.py,sha256=8yToQWeV_apWErYQ2J-WY2kfFntaDU3l_ZwbeQlE6yM,66
+chartrank/codegen.py,sha256=UjJbQqz4N0DX90UxL1g8wwUSVIw3Qyju7sGvB-WWk5c,84
+chartrank/dictionary.py,sha256=ZkjDsv1iPk74I0OGe4cz4DolzYlbV8yM2ttfZC1ojCg,96
+chartrank/gallery.py,sha256=A30utvDd1iv_cbNhcQRRsZsPW2pBcbaK7iZ0ZRAXNYE,77
+chartrank/guards.py,sha256=ggHBBgjmEDx6esuc3b_vQUbvMUHmeSU66REPT2k18Bw,101
+chartrank/profile.py,sha256=MkjCJtL95IoYV8sc4nOfdle-P8Jg8_aq8TNXLSCkWPU,1598
+chartrank/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+chartrank/recommend.py,sha256=hzhrP1SHqpkzn9f3A8hpO9gciM4_3SoYFtUeizhcS6Q,88
+chartrank/spec.py,sha256=3VQSlaI582PkGxnnvvOAwtdxgkNL73NmMWCEQmHF-Ls,69
+chartrank/target.py,sha256=_zjB2DDYvurxbWzbwHv8B9RnntRvJeMo4eFJv4Jo1ps,97
+chartrank/render/__init__.py,sha256=EvDhWIYdWtl87fugTgVlCFUChryghjvh4i_PRvHbMnI,62
+chartrank/render/plotly.py,sha256=I5AlyE-TR0mXj5H06LzMUf_SDQ_3IrATcU1SuQz2fkc,87
+chartrank-0.1.0.dist-info/METADATA,sha256=9IFovlFd7XmYejnuPrgUKdgD9-8OhDxnfkomUN7oJJg,3202
+chartrank-0.1.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+chartrank-0.1.0.dist-info/licenses/LICENSE,sha256=0ksk9JlOBL2INVYcn7HrQ0GEaUVT17r45K1ii-IZN9M,1080
+chartrank-0.1.0.dist-info/RECORD,,

chartrank-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

chartrank-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Faïd Adéshinan ALAGBE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.