Merge pull request #3 from compas-dev/rename-to-compas-plotter

Rename package compas_plotters -> compas_plotter

Author: gonzalocasas

.github/workflows/docs.yml

@@ -17,5 +17,5 @@ jobs:
       - uses: compas-dev/compas-actions.docs@v5
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          doc_url: https://compas.dev/compas_plotters
+          doc_url: https://compas.dev/compas_plotter
           generator: mkdocs

AGENTS.md

@@ -1,11 +1,11 @@
 # AGENTS.md
 
-Guidance for AI coding agents (and humans) working on **compas_plotters**.
+Guidance for AI coding agents (and humans) working on **compas_plotter**.
 This is the canonical onboarding doc; `CLAUDE.md` just imports it.
 
 ## What this is
 
-`compas_plotters` is the COMPAS 2.x revival of the 2D matplotlib visualisation
+`compas_plotter` is the COMPAS 2.x revival of the 2D matplotlib visualisation
 package that shipped inside COMPAS up to 1.17. It draws COMPAS geometry and data
 structures onto a matplotlib canvas via the modern `compas.scene` system, by
 registering a `"Plotter"` visualisation context — the same mechanism the Rhino,
@@ -16,22 +16,22 @@ to PyPI and the GitHub repo may not exist yet.
 
 ## Architecture in 60 seconds
 
-- **`Plotter`** ([src/compas_plotters/plotter.py](src/compas_plotters/plotter.py)) —
+- **`Plotter`** ([src/compas_plotter/plotter.py](src/compas_plotter/plotter.py)) —
   wraps a matplotlib figure/axes. Public API: `add`, `add_from_list`, `find`,
   `zoom_extents`, `draw`, `redraw`, `show`, `save`, `pause`, `register_listener`,
   `on` (dynamic/animation + GIF).
-- **`PlotterScene(compas.scene.Scene)`** ([scene/plotterscene.py](src/compas_plotters/scene/plotterscene.py)) —
+- **`PlotterScene(compas.scene.Scene)`** ([scene/plotterscene.py](src/compas_plotter/scene/plotterscene.py)) —
   the container. Every `Plotter` owns one (`plotter.scene`), context hardcoded to
   `"Plotter"`. `Plotter.add` delegates to `PlotterScene.add`, which injects the
   owning plotter into each scene object and draws it. This gives a real scene tree
   (parent/child, composed `worldtransformation`) and serialization. Pattern copied
   from `compas_viewer`'s `ViewerScene`.
-- **`PlotterSceneObject`** ([scene/plotterobject.py](src/compas_plotters/scene/plotterobject.py)) —
+- **`PlotterSceneObject`** ([scene/plotterobject.py](src/compas_plotter/scene/plotterobject.py)) —
   base for all drawable objects. Subclasses implement `draw()` (returns the list
   of matplotlib artists, stored on `self._mpl_objects`) and `viewdata()` (the
   `[x, y]` points used by `zoom_extents`). `clear()` and `redraw()` are provided.
   Also exposes helpers `to_rgb()` and `to_color()`.
-- **Registration** ([scene/__init__.py](src/compas_plotters/scene/__init__.py)) —
+- **Registration** ([scene/__init__.py](src/compas_plotter/scene/__init__.py)) —
   `@plugin(category="factories") register_scene_objects()` maps each COMPAS type
   to its object with `register(T, O, context="Plotter")`. It is **also called
   eagerly at import** so the package works without entry-point discovery (editable
@@ -113,22 +113,22 @@ python -m mkdocs serve      # live docs preview
 There are two patterns already in the tree — copy the closest one.
 
 **A. A single COMPAS type → dedicated object.** See
-[scene/circleobject.py](src/compas_plotters/scene/circleobject.py) (geometry) or
-[scene/boxobject.py](src/compas_plotters/scene/boxobject.py) (shape).
+[scene/circleobject.py](src/compas_plotter/scene/circleobject.py) (geometry) or
+[scene/boxobject.py](src/compas_plotter/scene/boxobject.py) (shape).
 
 1. Create `scene/<thing>object.py` with
    `class <Thing>Object(PlotterSceneObject, GeometryObject)` (or `MeshObject` /
    `GraphObject` base for data structures).
 2. Implement `__init__` (call `super().__init__(zorder=..., **kwargs)`; set your
    style attrs), `viewdata()`, and `draw()` (build matplotlib artists, append to
    `self._mpl_objects`, `return self._mpl_objects`).
-3. In [scene/__init__.py](src/compas_plotters/scene/__init__.py): import it, add
+3. In [scene/__init__.py](src/compas_plotter/scene/__init__.py): import it, add
    `register(<Thing>, <Thing>Object, context="Plotter")` inside
    `register_scene_objects()`, and add it to `__all__`.
 4. Add a test in [tests/test_plotter.py](tests/test_plotter.py) and a CHANGELOG entry.
 
 **B. A family of types → one shared object.** See
-[scene/shapeobject.py](src/compas_plotters/scene/shapeobject.py): `ShapeObject`
+[scene/shapeobject.py](src/compas_plotter/scene/shapeobject.py): `ShapeObject`
 tessellates any `Shape` with `to_vertices_and_faces()` and projects to XY; the
 registration loop maps several classes to it.
 
@@ -138,7 +138,7 @@ Breps and surfaces are the main remaining gap. Plan: tessellate to a mesh
 (`Brep.to_tesselation()` / surface sampling) and project to XY, mirroring
 `ShapeObject`. Breps require an optional backend (e.g. `compas_occ`), so register
 them inside a `try/except ImportError` block (see git history of
-[scene/__init__.py](src/compas_plotters/scene/__init__.py) for the guarded pattern).
+[scene/__init__.py](src/compas_plotter/scene/__init__.py) for the guarded pattern).
 
 ## Release
 

CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-* Initial COMPAS 2.x port of `compas_plotters`.
+* Initial COMPAS 2.x port of `compas_plotters` (the package that shipped inside COMPAS up to 1.17).
 * `Plotter` class for 2D matplotlib visualisation, including dynamic plotting
   (`Plotter.on`) with optional GIF recording.
 * `"Plotter"` visualisation context built on `compas.scene`.

CITATION.cff

@@ -12,8 +12,8 @@ authors:
   - family-names: "Casas"
     given-names: "Gonzalo"
     affiliation: "ETH Zurich"
-url: "https://github.com/compas-dev/compas_plotters"
-repository-code: "https://github.com/compas-dev/compas_plotters"
+url: "https://github.com/compas-dev/compas_plotter"
+repository-code: "https://github.com/compas-dev/compas_plotter"
 license: MIT
 version: "0.1.0"
 date-released: 2026-06-30

README.md

@@ -1,12 +1,12 @@
 # COMPAS Plotters
 
-![build](https://github.com/compas-dev/compas_plotters/workflows/build/badge.svg)
-[![License](https://img.shields.io/github/license/compas-dev/compas_plotters.svg)](https://github.com/compas-dev/compas_plotters/blob/main/LICENSE)
-[![PyPI](https://img.shields.io/pypi/v/compas_plotters.svg)](https://pypi.org/project/compas_plotters/)
+![build](https://github.com/compas-dev/compas_plotter/workflows/build/badge.svg)
+[![License](https://img.shields.io/github/license/compas-dev/compas_plotter.svg)](https://github.com/compas-dev/compas_plotter/blob/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/compas_plotter.svg)](https://pypi.org/project/compas_plotter/)
 
 **2D visualisation of COMPAS geometry and data structures, powered by matplotlib.**
 
-`compas_plotters` provides a lightweight, dependency-free (other than matplotlib)
+`compas_plotter` provides a lightweight, dependency-free (other than matplotlib)
 way to draw COMPAS objects in 2D. It is the COMPAS 2.x successor of the
 `compas_plotters` package that shipped inside COMPAS up to version 1.17, rebuilt
 on top of the modern [`compas.scene`](https://compas.dev/compas/latest/) system.
@@ -16,15 +16,15 @@ registered plotter scene object can be drawn with a single `plotter.add(...)`.
 ## Installation
 
 ```bash
-pip install compas_plotters
+pip install compas_plotter
 ```
 
 ## Quick start
 
 ```python
 from compas.geometry import Point, Line, Polygon
 from compas.datastructures import Mesh
-from compas_plotters import Plotter
+from compas_plotter import Plotter
 
 plotter = Plotter(figsize=(8, 5))
 
@@ -62,8 +62,8 @@ Planned additions, most likely drawn as XY projections following the existing
 ## Documentation
 
 Full documentation is available at
-[compas.dev/compas_plotters](https://compas.dev/compas_plotters).
+[compas.dev/compas_plotter](https://compas.dev/compas_plotter).
 
 ## License
 
-`compas_plotters` is released under the [MIT License](LICENSE).
+`compas_plotter` is released under the [MIT License](LICENSE).

docs/api/compas_plotter.md

@@ -0,0 +1 @@
+# ::: compas_plotter.Plotter

docs/api/compas_plotter.scene.md

@@ -0,0 +1 @@
+# ::: compas_plotter.scene

docs/api/compas_plotters.md

@@ -1,9 +1,9 @@
 # API Reference
 
-The public API of `compas_plotters` is small:
+The public API of `compas_plotter` is small:
 
-- **[compas_plotters](compas_plotters.md)** — the [`Plotter`][compas_plotters.Plotter]
+- **[compas_plotter](compas_plotter.md)** — the [`Plotter`][compas_plotter.Plotter]
   class, the main entry point for building 2D plots.
-- **[compas_plotters.scene](compas_plotters.scene.md)** — the `"Plotter"`
+- **[compas_plotter.scene](compas_plotter.scene.md)** — the `"Plotter"`
   visualisation-context scene objects, one per supported COMPAS type. You rarely
   instantiate these directly; `Plotter.add` creates them for you.