plotjs 0.0.6__py3-none-any.whl

plotjs/__init__.py

@@ -0,0 +1,6 @@
+from .main import PlotJS
+
+__version__ = "0.0.6"
+__all__: list[str] = [
+    "PlotJS",
+]

plotjs/css.py

@@ -0,0 +1,100 @@
+import re
+import warnings
+
+
+def from_dict(css_dict: dict) -> str:
+    """
+    Get raw CSS in a string from a dictionnary. It's a
+    utility function useful to write CSS from a Python
+    dictionnary.
+
+    Args:
+        css_dict: A dictionnary with keys (selectors) and value
+            (dictionnary of property-value).
+
+    Returns:
+        A string of raw CSS.
+
+    Examples:
+        ```python
+        from plotjs import css
+
+        css.from_dict({
+            ".tooltip": {"color": "red", "background": "blue !important"},
+            ".point": {"width": "10px", "height": "200px"},
+        })
+        ```
+    """
+    css: str = ""
+
+    for selector, css_props in css_dict.items():
+        css += f"{selector}{{"
+        for prop, value in css_props.items():
+            css += f"{prop}:{value};"
+        css += "}"
+
+    if not is_css_like(css):
+        warnings.warn(f"CSS may be invalid: {css}")
+
+    return css
+
+
+def from_file(css_file: str) -> str:
+    """
+    Get raw CSS from a CSS file. This function just
+    reads the CSS from a given file and checks that
+    it looks like valid CSS.
+
+    Args:
+        css_file: Path to a CSS file.
+
+    Returns:
+        A string of raw CSS
+
+    Examples:
+        ```python
+        from plotjs import css
+
+        css.from_file("path/to/style.css")
+        ```
+    """
+    with open(css_file, "r") as f:
+        css: str = f.read()
+
+    if not is_css_like(css):
+        warnings.warn(f"CSS may be invalid: {css}", category=UserWarning)
+    return css
+
+
+def is_css_like(s: str) -> bool:
+    """
+    Check whether a string looks like valid CSS. This function
+    is primarly used internally, but you can use it too.
+
+    Args:
+        s: A string to evaluate.
+
+    Returns:
+        Whether or not `s` looks like valid CSS.
+
+    Examples:
+        ```python
+        from plotjs import is_css_like
+
+        is_css_like("This is not CSS.") # False
+        is_css_like(".box { broken }") # False
+        is_css_like(".tooltip { color: red; background: blue; }") # True
+        ```
+    """
+    css_block_pattern = re.compile(
+        r"""
+        [^{]+\s*              # Selector (at least one char that's not '{')
+        \{\s*                 # Opening brace
+        ([^:{}]+:\s*[^;{}]+;\s*)+  # At least one prop: value; pair
+        \}                    # Closing brace
+        """,
+        re.VERBOSE,
+    )
+
+    matches = css_block_pattern.findall(s)
+    return bool(matches)

plotjs/data/__init__.py

@@ -0,0 +1,3 @@
+from .datasets import load_iris, load_mtcars, load_titanic, _load_data
+
+__all__: list[str] = ["load_iris", "load_mtcars", "_load_data", "load_titanic"]

plotjs/data/datasets.py

@@ -0,0 +1,138 @@
+import narwhals.stable.v2 as nw
+import os
+
+from narwhals.stable.v2.typing import Frame
+
+PACKAGE_DIR: str = os.path.dirname(os.path.abspath(__file__))
+AVAILABLE_DATASETS: list[str] = ["iris", "mtcars", "titanic"]
+
+
+def _load_data(dataset_name: str, backend: str) -> Frame:
+    """
+    Load one of the available datasets in fleur.
+
+    Args:
+        dataset_name: A string specifying the name of the dataset. Currently,
+            "iris", "mtcars" and "titanic" are supported.
+        backend: The output format of the dataframe.
+
+    Returns:
+        A dataframe with the specified dataset.
+    """
+    dataset_name: str = dataset_name.lower()
+
+    if dataset_name not in AVAILABLE_DATASETS:
+        raise ValueError(
+            f"dataset_name must be one of: {' ,'.join(AVAILABLE_DATASETS)}"
+        )
+
+    dataset_file: str = f"{dataset_name}.csv"
+    dataset_path: str = os.path.join(PACKAGE_DIR, dataset_file)
+    df: Frame = nw.read_csv(dataset_path, backend=backend)
+
+    return df.to_native()
+
+
+def load_iris(output_format: str = "pandas") -> Frame:
+    """
+    Load the iris dataset.
+
+    Args:
+        output_format: The output format of the dataframe. Note that, for example,
+            if you set `output_format="polars"`, you must have polars installed.
+            Must be one of the following: "pandas", "polars", "pyarrow", "modin",
+            "cudf". Default to "pandas".
+
+    Returns:
+        The iris dataset.
+
+    Examples:
+        ```python
+        from plotjs import data
+
+        df = data.load_iris()
+        ```
+
+        ```python
+        from plotjs import data
+
+        df = data.load_iris("polars")
+        ```
+
+        ```python
+        from plotjs import data
+
+        df = data.load_iris("pyarrow")
+        ```
+    """
+    return _load_data("iris", backend=output_format)
+
+
+def load_mtcars(output_format: str = "pandas") -> Frame:
+    """
+    Load the mtcars dataset.
+
+    Args:
+        output_format: The output format of the dataframe. Note that, for example,
+            if you set `output_format="polars"`, you must have polars installed.
+            Must be one of the following: "pandas", "polars", "pyarrow", "modin",
+            "cudf". Default to "pandas".
+
+    Returns:
+        The mtcars dataset.
+
+    Examples:
+        ```python
+        from plotjs import data
+
+        df = data.load_mtcars()
+        ```
+
+        ```python
+        from plotjs import data
+
+        df = data.load_mtcars("polars")
+        ```
+
+        ```python
+        from plotjs import data
+
+        df = data.load_mtcars("pyarrow")
+        ```
+    """
+    return _load_data("mtcars", backend=output_format)
+
+
+def load_titanic(output_format: str = "pandas") -> Frame:
+    """
+    Load the titanic dataset.
+
+    Args:
+        output_format: The output format of the dataframe. Note that, for example,
+            if you set `output_format="polars"`, you must have polars installed.
+            Must be one of the following: "pandas", "polars", "pyarrow", "modin",
+            "cudf". Default to "pandas".
+
+    Returns:
+        The titanic dataset.
+
+    Examples:
+        ```python
+        from plotjs import data
+
+        df = data.load_titanic()
+        ```
+
+        ```python
+        from plotjs import data
+
+        df = data.load_titanic("polars")
+        ```
+
+        ```python
+        from plotjs import data
+
+        df = data.load_titanic("pyarrow")
+        ```
+    """
+    return _load_data("titanic", backend=output_format)

plotjs/data/iris.csv

@@ -0,0 +1,151 @@
+sepal_length,sepal_width,petal_length,petal_width,species
+5.1,3.5,1.4,0.2,setosa
+4.9,3.0,1.4,0.2,setosa
+4.7,3.2,1.3,0.2,setosa
+4.6,3.1,1.5,0.2,setosa
+5.0,3.6,1.4,0.2,setosa
+5.4,3.9,1.7,0.4,setosa
+4.6,3.4,1.4,0.3,setosa
+5.0,3.4,1.5,0.2,setosa
+4.4,2.9,1.4,0.2,setosa
+4.9,3.1,1.5,0.1,setosa
+5.4,3.7,1.5,0.2,setosa
+4.8,3.4,1.6,0.2,setosa
+4.8,3.0,1.4,0.1,setosa
+4.3,3.0,1.1,0.1,setosa
+5.8,4.0,1.2,0.2,setosa
+5.7,4.4,1.5,0.4,setosa
+5.4,3.9,1.3,0.4,setosa
+5.1,3.5,1.4,0.3,setosa
+5.7,3.8,1.7,0.3,setosa
+5.1,3.8,1.5,0.3,setosa
+5.4,3.4,1.7,0.2,setosa
+5.1,3.7,1.5,0.4,setosa
+4.6,3.6,1.0,0.2,setosa
+5.1,3.3,1.7,0.5,setosa
+4.8,3.4,1.9,0.2,setosa
+5.0,3.0,1.6,0.2,setosa
+5.0,3.4,1.6,0.4,setosa
+5.2,3.5,1.5,0.2,setosa
+5.2,3.4,1.4,0.2,setosa
+4.7,3.2,1.6,0.2,setosa
+4.8,3.1,1.6,0.2,setosa
+5.4,3.4,1.5,0.4,setosa
+5.2,4.1,1.5,0.1,setosa
+5.5,4.2,1.4,0.2,setosa
+4.9,3.1,1.5,0.1,setosa
+5.0,3.2,1.2,0.2,setosa
+5.5,3.5,1.3,0.2,setosa
+4.9,3.1,1.5,0.1,setosa
+4.4,3.0,1.3,0.2,setosa
+5.1,3.4,1.5,0.2,setosa
+5.0,3.5,1.3,0.3,setosa
+4.5,2.3,1.3,0.3,setosa
+4.4,3.2,1.3,0.2,setosa
+5.0,3.5,1.6,0.6,setosa
+5.1,3.8,1.9,0.4,setosa
+4.8,3.0,1.4,0.3,setosa
+5.1,3.8,1.6,0.2,setosa
+4.6,3.2,1.4,0.2,setosa
+5.3,3.7,1.5,0.2,setosa
+5.0,3.3,1.4,0.2,setosa
+7.0,3.2,4.7,1.4,versicolor
+6.4,3.2,4.5,1.5,versicolor
+6.9,3.1,4.9,1.5,versicolor
+5.5,2.3,4.0,1.3,versicolor
+6.5,2.8,4.6,1.5,versicolor
+5.7,2.8,4.5,1.3,versicolor
+6.3,3.3,4.7,1.6,versicolor
+4.9,2.4,3.3,1.0,versicolor
+6.6,2.9,4.6,1.3,versicolor
+5.2,2.7,3.9,1.4,versicolor
+5.0,2.0,3.5,1.0,versicolor
+5.9,3.0,4.2,1.5,versicolor
+6.0,2.2,4.0,1.0,versicolor
+6.1,2.9,4.7,1.4,versicolor
+5.6,2.9,3.6,1.3,versicolor
+6.7,3.1,4.4,1.4,versicolor
+5.6,3.0,4.5,1.5,versicolor
+5.8,2.7,4.1,1.0,versicolor
+6.2,2.2,4.5,1.5,versicolor
+5.6,2.5,3.9,1.1,versicolor
+5.9,3.2,4.8,1.8,versicolor
+6.1,2.8,4.0,1.3,versicolor
+6.3,2.5,4.9,1.5,versicolor
+6.1,2.8,4.7,1.2,versicolor
+6.4,2.9,4.3,1.3,versicolor
+6.6,3.0,4.4,1.4,versicolor
+6.8,2.8,4.8,1.4,versicolor
+6.7,3.0,5.0,1.7,versicolor
+6.0,2.9,4.5,1.5,versicolor
+5.7,2.6,3.5,1.0,versicolor
+5.5,2.4,3.8,1.1,versicolor
+5.5,2.4,3.7,1.0,versicolor
+5.8,2.7,3.9,1.2,versicolor
+6.0,2.7,5.1,1.6,versicolor
+5.4,3.0,4.5,1.5,versicolor
+6.0,3.4,4.5,1.6,versicolor
+6.7,3.1,4.7,1.5,versicolor
+6.3,2.3,4.4,1.3,versicolor
+5.6,3.0,4.1,1.3,versicolor
+5.5,2.5,4.0,1.3,versicolor
+5.5,2.6,4.4,1.2,versicolor
+6.1,3.0,4.6,1.4,versicolor
+5.8,2.6,4.0,1.2,versicolor
+5.0,2.3,3.3,1.0,versicolor
+5.6,2.7,4.2,1.3,versicolor
+5.7,3.0,4.2,1.2,versicolor
+5.7,2.9,4.2,1.3,versicolor
+6.2,2.9,4.3,1.3,versicolor
+5.1,2.5,3.0,1.1,versicolor
+5.7,2.8,4.1,1.3,versicolor
+6.3,3.3,6.0,2.5,virginica
+5.8,2.7,5.1,1.9,virginica
+7.1,3.0,5.9,2.1,virginica
+6.3,2.9,5.6,1.8,virginica
+6.5,3.0,5.8,2.2,virginica
+7.6,3.0,6.6,2.1,virginica
+4.9,2.5,4.5,1.7,virginica
+7.3,2.9,6.3,1.8,virginica
+6.7,2.5,5.8,1.8,virginica
+7.2,3.6,6.1,2.5,virginica
+6.5,3.2,5.1,2.0,virginica
+6.4,2.7,5.3,1.9,virginica
+6.8,3.0,5.5,2.1,virginica
+5.7,2.5,5.0,2.0,virginica
+5.8,2.8,5.1,2.4,virginica
+6.4,3.2,5.3,2.3,virginica
+6.5,3.0,5.5,1.8,virginica
+7.7,3.8,6.7,2.2,virginica
+7.7,2.6,6.9,2.3,virginica
+6.0,2.2,5.0,1.5,virginica
+6.9,3.2,5.7,2.3,virginica
+5.6,2.8,4.9,2.0,virginica
+7.7,2.8,6.7,2.0,virginica
+6.3,2.7,4.9,1.8,virginica
+6.7,3.3,5.7,2.1,virginica
+7.2,3.2,6.0,1.8,virginica
+6.2,2.8,4.8,1.8,virginica
+6.1,3.0,4.9,1.8,virginica
+6.4,2.8,5.6,2.1,virginica
+7.2,3.0,5.8,1.6,virginica
+7.4,2.8,6.1,1.9,virginica
+7.9,3.8,6.4,2.0,virginica
+6.4,2.8,5.6,2.2,virginica
+6.3,2.8,5.1,1.5,virginica
+6.1,2.6,5.6,1.4,virginica
+7.7,3.0,6.1,2.3,virginica
+6.3,3.4,5.6,2.4,virginica
+6.4,3.1,5.5,1.8,virginica
+6.0,3.0,4.8,1.8,virginica
+6.9,3.1,5.4,2.1,virginica
+6.7,3.1,5.6,2.4,virginica
+6.9,3.1,5.1,2.3,virginica
+5.8,2.7,5.1,1.9,virginica
+6.8,3.2,5.9,2.3,virginica
+6.7,3.3,5.7,2.5,virginica
+6.7,3.0,5.2,2.3,virginica
+6.3,2.5,5.0,1.9,virginica
+6.5,3.0,5.2,2.0,virginica
+6.2,3.4,5.4,2.3,virginica
+5.9,3.0,5.1,1.8,virginica

plotjs/data/mtcars.csv

@@ -0,0 +1,33 @@
+model,mpg,cyl,disp,hp,drat,wt,qsec,vs,am,gear,carb
+Mazda RX4,21,6,160,110,3.9,2.62,16.46,0,1,4,4
+Mazda RX4 Wag,21,6,160,110,3.9,2.875,17.02,0,1,4,4
+Datsun 710,22.8,4,108,93,3.85,2.32,18.61,1,1,4,1
+Hornet 4 Drive,21.4,6,258,110,3.08,3.215,19.44,1,0,3,1
+Hornet Sportabout,18.7,8,360,175,3.15,3.44,17.02,0,0,3,2
+Valiant,18.1,6,225,105,2.76,3.46,20.22,1,0,3,1
+Duster 360,14.3,8,360,245,3.21,3.57,15.84,0,0,3,4
+Merc 240D,24.4,4,146.7,62,3.69,3.19,20,1,0,4,2
+Merc 230,22.8,4,140.8,95,3.92,3.15,22.9,1,0,4,2
+Merc 280,19.2,6,167.6,123,3.92,3.44,18.3,1,0,4,4
+Merc 280C,17.8,6,167.6,123,3.92,3.44,18.9,1,0,4,4
+Merc 450SE,16.4,8,275.8,180,3.07,4.07,17.4,0,0,3,3
+Merc 450SL,17.3,8,275.8,180,3.07,3.73,17.6,0,0,3,3
+Merc 450SLC,15.2,8,275.8,180,3.07,3.78,18,0,0,3,3
+Cadillac Fleetwood,10.4,8,472,205,2.93,5.25,17.98,0,0,3,4
+Lincoln Continental,10.4,8,460,215,3,5.424,17.82,0,0,3,4
+Chrysler Imperial,14.7,8,440,230,3.23,5.345,17.42,0,0,3,4
+Fiat 128,32.4,4,78.7,66,4.08,2.2,19.47,1,1,4,1
+Honda Civic,30.4,4,75.7,52,4.93,1.615,18.52,1,1,4,2
+Toyota Corolla,33.9,4,71.1,65,4.22,1.835,19.9,1,1,4,1
+Toyota Corona,21.5,4,120.1,97,3.7,2.465,20.01,1,0,3,1
+Dodge Challenger,15.5,8,318,150,2.76,3.52,16.87,0,0,3,2
+AMC Javelin,15.2,8,304,150,3.15,3.435,17.3,0,0,3,2
+Camaro Z28,13.3,8,350,245,3.73,3.84,15.41,0,0,3,4
+Pontiac Firebird,19.2,8,400,175,3.08,3.845,17.05,0,0,3,2
+Fiat X1-9,27.3,4,79,66,4.08,1.935,18.9,1,1,4,1
+Porsche 914-2,26,4,120.3,91,4.43,2.14,16.7,0,1,5,2
+Lotus Europa,30.4,4,95.1,113,3.77,1.513,16.9,1,1,5,2
+Ford Pantera L,15.8,8,351,264,4.22,3.17,14.5,0,1,5,4
+Ferrari Dino,19.7,6,145,175,3.62,2.77,15.5,0,1,5,6
+Maserati Bora,15,8,301,335,3.54,3.57,14.6,0,1,5,8
+Volvo 142E,21.4,4,121,109,4.11,2.78,18.6,1,1,4,2