Merge branch 'main' of https://github.com/palewire/Datawrapper

Author: palewire

.devcontainer/devcontainer.json

@@ -0,0 +1,58 @@
+{
+  "name": "Datawrapper Python Development",
+  "image": "mcr.microsoft.com/devcontainers/python:3.12",
+
+  "features": {
+    "ghcr.io/devcontainers/features/git:1": {},
+    "ghcr.io/devcontainers/features/github-cli:1": {}
+  },
+
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "charliermarsh.ruff",
+        "ms-python.pytest",
+        "ms-toolsai.jupyter"
+      ],
+
+      "settings": {
+        "python.defaultInterpreterPath": "/usr/local/bin/python",
+        "python.testing.pytestEnabled": true,
+        "python.testing.unittestEnabled": false,
+        "python.testing.pytestArgs": [
+          "tests"
+        ],
+        "[python]": {
+          "editor.defaultFormatter": "charliermarsh.ruff",
+          "editor.formatOnSave": true,
+          "editor.codeActionsOnSave": {
+            "source.fixAll": "explicit",
+            "source.organizeImports": "explicit"
+          }
+        },
+        "files.exclude": {
+          "**/__pycache__": true,
+          "**/*.pyc": true,
+          "**/.pytest_cache": true,
+          "**/.ruff_cache": true,
+          "**/htmlcov": true,
+          "**/*.egg-info": true
+        }
+      }
+    }
+  },
+
+  "forwardPorts": [8000],
+  "portsAttributes": {
+    "8000": {
+      "label": "Documentation Server",
+      "onAutoForward": "notify"
+    }
+  },
+
+  "postCreateCommand": "bash .devcontainer/setup.sh",
+
+  "shutdownAction": "stopContainer"
+}

.devcontainer/setup.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -e
+
+echo "🚀 Setting up Datawrapper development environment..."
+
+# Install uv package manager
+echo "📦 Installing uv package manager..."
+curl -LsSf https://astral.sh/uv/install.sh | sh
+export PATH="$HOME/.cargo/bin:$PATH"
+
+# Install all project dependencies
+echo "📚 Installing project dependencies..."
+uv install --all-extras
+
+# Install pre-commit hooks
+echo "🔧 Installing pre-commit hooks..."
+uv run pre-commit install

CHANGELOG.md

@@ -9,7 +9,6 @@ A lightweight Python wrapper for the Datawrapper API
 * Get, update and delete folders, users and teams.
 * Retrieve lists of recently edited and updated charts
 * Access metadata about your account
-* Get a list of all available themes
 
 ## Installation
 
@@ -23,18 +22,18 @@ Create beautiful charts with type-safe, object-oriented Python:
 
 ```python
 import pandas as pd
-from datawrapper import BarChart, NumberFormat
+import datawrapper as dw
 
-# Create a bar chart with type-safe configuration
-chart = BarChart(
+# Configure a bar chart
+chart = dw.BarChart(
     title="Top Programming Languages 2024",
     data=pd.DataFrame({"Language": ["Python", "JavaScript", "Java"], "Users": [45.3, 38.2, 30.5]}),
-    axis_label_format=NumberFormat.ONE_DECIMAL,  # Type-safe enum
-    value_label_format=NumberFormat.ABBREVIATED,  # IDE autocomplete support
+    axis_label_format=NumberFormat.ONE_DECIMAL,
+    value_label_format=NumberFormat.ABBREVIATED,
 )
 
 # Create and publish (uses DATAWRAPPER_ACCESS_TOKEN environment variable)
-chart_id = chart.create()
+chart.create()
 chart.publish()
 ```
 See the [full documentation](https://datawrapper.readthedocs.io/) for comprehensive guides on all chart types.
@@ -53,7 +52,6 @@ Install pre-commit to run a battery of automatic quick fixes against your work.
 
 ```bash
 uv run pre-commit install
-uv run pre-commit install
 ```
 
 Run tests with

README.md

@@ -49,6 +49,13 @@ class ArrowChart(BaseChart):
     # Customize arrows
     #
 
+    #: The base color for the arrows
+    base_color: str | int = Field(
+        default=0,
+        alias="base-color",
+        description="The base color for the arrows",
+    )
+
     #: A mapping of layer names to colors
     color_category: dict[str, str] = Field(
         default_factory=dict,
@@ -152,6 +159,20 @@ class ArrowChart(BaseChart):
         description="The column that arrows should end at",
     )
 
+    #: The axes to color by
+    axis_colors: str = Field(
+        default="",
+        alias="axis-colors",
+        description="The axes to color by",
+    )
+
+    #: The axes to label by
+    axis_labels: str = Field(
+        default="",
+        alias="axis-labels",
+        description="The axes to label by",
+    )
+
     #
     # Features
     #
@@ -203,6 +224,7 @@ def serialize_model(self) -> dict:
                 "y-grid": self.y_grid,
                 "reverse-order": self.reverse_order,
                 "thick-arrows": self.thick_arrows,
+                "base-color": self.base_color,
                 "color-category": ColorCategory.serialize(self.color_category),
                 "range-value-labels": self.range_value_labels,
                 "sort-range": {
@@ -224,6 +246,10 @@ def serialize_model(self) -> dict:
             "start": self.axis_start,
             "end": self.axis_end,
         }
+        if self.axis_colors:
+            model["metadata"]["axes"]["colors"] = self.axis_colors
+        if self.axis_labels:
+            model["metadata"]["axes"]["labels"] = self.axis_labels
 
         # Return the serialized data
         return model
@@ -254,6 +280,10 @@ def deserialize_model(cls, api_response: dict[str, Any]) -> dict[str, Any]:
         if "thick-arrows" in visualize:
             init_data["thick_arrows"] = visualize["thick-arrows"]
 
+        # Base color
+        if "base-color" in visualize:
+            init_data["base_color"] = visualize["base-color"]
+
         # Parse color-category using utility
         color_data = ColorCategory.deserialize(visualize.get("color-category"))
         init_data["color_category"] = color_data["color_category"]
@@ -291,6 +321,10 @@ def deserialize_model(cls, api_response: dict[str, Any]) -> dict[str, Any]:
             init_data["axis_start"] = axes["start"]
         if "end" in axes:
             init_data["axis_end"] = axes["end"]
+        if "colors" in axes:
+            init_data["axis_colors"] = axes["colors"]
+        if "labels" in axes:
+            init_data["axis_labels"] = axes["labels"]
 
         # Features
         if "color-by-column" in visualize:

datawrapper/charts/arrow.py

@@ -5,17 +5,11 @@
 from typing import Any, Literal
 
 import pandas as pd
-from IPython.display import Image
+from IPython.display import IFrame, Image
 from pydantic import BaseModel, ConfigDict, Field, model_serializer, model_validator
 
 from datawrapper.__main__ import Datawrapper
-from datawrapper.charts.models import (
-    Annotate,
-    Describe,
-    Publish,
-    Transform,
-    Visualize,
-)
+from datawrapper.charts.models import Annotate, Describe, Publish, Transform, Visualize
 
 
 class BaseChart(BaseModel):
@@ -986,6 +980,31 @@ def get_iframe_code(
         # Call the get_iframe_code method from the client
         return client.get_iframe_code(chart_id=self.chart_id, responsive=responsive)
 
+    def display(self, access_token: str | None = None) -> IFrame:
+        """Display the chart as an IFrame in a Jupyter notebook.
+
+        Args:
+            access_token: Optional Datawrapper API access token.
+                         If not provided, will use DATAWRAPPER_ACCESS_TOKEN environment variable.
+
+        Returns:
+            An IPython.display.IFrame object displaying the chart.
+
+        Raises:
+            ValueError: If no chart_id is set or no access token is available.
+            Exception: If the API request fails.
+        """
+        if not self.chart_id:
+            raise ValueError(
+                "No chart_id set. Use create() first or set chart_id manually."
+            )
+
+        # Get the client
+        client = self._get_client(access_token)
+
+        # Call the display_chart method from the client
+        return client.display_chart(chart_id=self.chart_id)
+
     def get_editor_url(self) -> str:
         """Get the Datawrapper editor URL for this chart.