rename BCRouter to FigureRouter

oliverlambson · Aug 25, 2024 · 45fcd64 · 45fcd64
1 parent 02155ad
commit 45fcd64
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 20 deletions.
diff --git a/bored-charts/README.md b/bored-charts/README.md
@@ -24,9 +24,9 @@ from pathlib import Path
 
 import plotly.express as px
 import plotly.graph_objects as go
-from boredcharts import BCRouter, boredcharts
+from boredcharts import FigureRouter, boredcharts
 
-figures = BCRouter()
+figures = FigureRouter()
 
 
 @figures.chart("population")

diff --git a/bored-charts/boredcharts/__init__.py b/bored-charts/boredcharts/__init__.py
@@ -1,9 +1,9 @@
-__version__ = "0.7.0"
+__version__ = "0.8.0"
 
-from boredcharts.router import BCRouter
+from boredcharts.router import FigureRouter
 from boredcharts.webapp import boredcharts
 
 __all__ = [
-    "BCRouter",
+    "FigureRouter",
     "boredcharts",
 ]
diff --git a/bored-charts/boredcharts/router.py b/bored-charts/boredcharts/router.py
@@ -40,16 +40,16 @@ def __get_pydantic_core_schema__(
         )
 
 
-class BCRouter(APIRouter):
+class FigureRouter(APIRouter):
     """A FastAPI router that turns charts into endpoints.
 
     Usage:
 
     ```py
-    from boredcharts import BCRouter
+    from boredcharts import FigureRouter
     import plotly.graph_objects as go
 
-    router = BCRouter()
+    router = FigureRouter()
 
     @router.chart("my_chart")
     async def my_chart() -> go.Figure:

diff --git a/bored-charts/boredcharts/webapp.py b/bored-charts/boredcharts/webapp.py
@@ -9,14 +9,14 @@
 from plotly.offline import get_plotlyjs
 
 from boredcharts.jinja import figure, md_to_html, row
-from boredcharts.router import BCRouter
+from boredcharts.router import FigureRouter
 
 module_root = Path(__file__).parent.absolute()
 
 
 def boredcharts(
     pages: Path,
-    figures: BCRouter | list[BCRouter],
+    figures: FigureRouter | list[FigureRouter],
     *,
     name: str = "bored-charts",
 ) -> FastAPI:

diff --git a/examples/full/analysis/elasticity.py b/examples/full/analysis/elasticity.py
@@ -1,9 +1,9 @@
 import matplotlib.figure as mplfig
 import matplotlib.pyplot as plt
 import numpy as np
-from boredcharts import BCRouter
+from boredcharts import FigureRouter
 
-figures = BCRouter()
+figures = FigureRouter()
 
 
 @figures.chart("elasticity_vs_profit")

diff --git a/examples/full/analysis/medals.py b/examples/full/analysis/medals.py
@@ -1,8 +1,8 @@
 import altair as alt
 import plotly.express as px
-from boredcharts import BCRouter
+from boredcharts import FigureRouter
 
-figures = BCRouter()
+figures = FigureRouter()
 
 
 @figures.chart("medals")

diff --git a/examples/full/analysis/population.py b/examples/full/analysis/population.py
@@ -1,8 +1,8 @@
 import plotly.express as px
-from boredcharts import BCRouter
+from boredcharts import FigureRouter
 from plotly.graph_objects import Figure
 
-figures = BCRouter(prefix="/population")
+figures = FigureRouter(prefix="/population")
 
 
 @figures.chart("population")

diff --git a/examples/minimal/main.py b/examples/minimal/main.py
@@ -2,9 +2,9 @@
 
 import plotly.express as px
 import plotly.graph_objects as go
-from boredcharts import BCRouter, boredcharts
+from boredcharts import FigureRouter, boredcharts
 
-figures = BCRouter()
+figures = FigureRouter()
 
 
 @figures.chart("population")

diff --git a/tests/test_routes.py b/tests/test_routes.py
@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from boredcharts.router import BCRouter
+from boredcharts.router import FigureRouter
 from boredcharts.webapp import boredcharts
 from fastapi.testclient import TestClient
 
@@ -9,7 +9,7 @@ def test_healthz() -> None:
     client = TestClient(
         boredcharts(
             pages=Path(__file__).parent / "pages",
-            figures=BCRouter(),
+            figures=FigureRouter(),
         )
     )
     response = client.get("/healthz")