Merge pull request #176 from plotly/andrew/meta

Fix up metadata

.pre-commit-config.yaml

@@ -18,12 +18,6 @@ repos:
     rev: v3.1.0
     hooks:
       - id: add-trailing-comma
-  #  alternative: isort
-  # optional comments: # noreorder
-  - repo: https://github.com/asottile/reorder-python-imports
-    rev: v3.14.0
-    hooks:
-      - id: reorder-python-imports
   - repo: https://github.com/astral-sh/ruff-pre-commit
     #  Ruff version.
     rev: v0.8.2

choreographer/DIR_INDEX.txt

@@ -0,0 +1,31 @@
+Files
+-----
+
+_browser.py
+
+A behemoth: contains process control, future storage, and user's primary interface.
+
+_cli_utils.py
+
+Functions to be used as scripts from commandline.
+
+_pipe.py
+
+The communication layer between choreographer and the browser.
+
+_tab.py
+
+Also part of user's primary interface. Intuitive, the user interacts with a "Browser"
+which has "Tabs".
+
+Directories
+-----------
+
+_devtools_protocol_layer/
+
+The browser-tab interface is intuitive, but here we have the interface that Chrome's
+Devtools Protocol actually provides.
+
+_system_utils/
+
+Some utilities we use to encourage cross-platform compatibility.

choreographer/__init__.py

@@ -1,17 +1,24 @@
-from .browser import Browser
-from .browser import browser_which
-from .browser import get_browser_path
-from .cli_utils import get_browser
-from .cli_utils import get_browser_sync
-from .tempfile import TempDirectory
-from .tempfile import TempDirWarning
+"""choreographer is a browser controller for python."""
+
+import choreographer._devtools_protocol_layer as protocol
+
+from ._browser import Browser, BrowserClosedError, browser_which, get_browser_path
+from ._cli_utils import get_browser, get_browser_sync
+from ._pipe import BlockWarning, PipeClosedError
+from ._system_utils._tempfile import TempDirectory, TempDirWarning
+from ._tab import Tab
 
 __all__ = [
-    Browser,
-    get_browser,
-    get_browser_sync,
-    browser_which,
-    get_browser_path,
-    TempDirectory,
-    TempDirWarning,
+    "BlockWarning",
+    "Browser",
+    "BrowserClosedError",
+    "PipeClosedError",
+    "Tab",
+    "TempDirWarning",
+    "TempDirectory",
+    "browser_which",
+    "get_browser",
+    "get_browser_path",
+    "get_browser_sync",
+    "protocol",
 ]