ocp-viewer-core 1.0.0__tar.gz

ocp_viewer_core-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [2024] Bernhard Walter
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

ocp_viewer_core-1.0.0/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: ocp-viewer-core
+Version: 1.0.0
+Summary: Shared viewer core for ocp_vscode, ocp_viewer, Jupyter CadQuery and build123d Studio
+Author-email: Bernhard Walter <b_walter@arcor.de>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/bernhard-42/ocp-viewer-core
+Project-URL: Bug Tracker, https://github.com/bernhard-42/ocp-viewer-core/issues
+Keywords: 3d models,3d viewing,3d,brep,cad,cadquery,opencascade,python
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ocp-tessellate<3.6.0,>=3.5.0
+Requires-Dist: orjson
+Requires-Dist: threejs-materials<1.3.0,>=1.2.0
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: bump-my-version; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# ocp-viewer-core
+
+The shared half of the OCP viewer ecosystem: one show suite, one tessellation, one set of config semantics, used by four viewers that each keep their own transport and their own settings storage.
+
+- **ocp_vscode** — the VS Code extension and its Python client
+- **ocp_viewer** — the standalone viewer, `python -m ocp_viewer`
+- **Jupyter CadQuery** — through cad-viewer-widget
+- **build123d Studio**
+
+Published as one project under one version to two registries: `ocp-viewer-core` on PyPI for the Python half, `ocp-viewer-core` on npm for the JavaScript half. The two are shipped and versioned together, so which version of the pair a host has is one question rather than two.
+
+## The idea
+
+Each host provides a `Comms` — a Python encoder and a JavaScript decoder, shipped as a pair — and a settings source. Everything above that is shared and knows nothing about which host it is running in. **No host is nameable inside this package**: no `port=`/`viewer=` pairs, no `is_jupyter_cadquery`, no environment sniffing, and no host name in a string. A conformance kit enforces that by running the shared half end to end over an in-memory loopback with no host at all.
+
+Per-host imports stay per host: `from ocp_vscode import show` beside `from build123d_studio import show`. A single universal import with the host discovered at runtime is deliberately not offered — it is how a `show()` once silently drew into somebody else's viewer.
+
+## Status
+
+Early development. Nothing here is published, and the API changes without notice until the first host adopts it.
+
+## Layout
+
+| path                        | what                                                                                                |
+| --------------------------- | --------------------------------------------------------------------------------------------------- |
+| `ocp_viewer_core/`          | the Python half                                                                                     |
+| `ocp_viewer_core/config.py` | the config keys, each mapped to the name three-cad-viewer knows it by, and the precedence over them |
+| `ocp_viewer_core/comms.py`  | the transport a host implements, and the session that caches what it answers                        |
+| `ocp_viewer_core/logo.py`   | the splash logo as measurable geometry, for a host's measurement backend                            |
+| `js/src/logo.js`            | the splash logo as tessellated data plus its config, for the renderer                                |
+| `js/`                       | the JavaScript half, published to npm                                                               |
+| `tests/`                    | including the conformance kit                                                                       |
+
+`ocp_viewer_core/__init__.py` is import-free by design: hosts import the submodule they need, so that importing the package never pulls in the tessellator or OCP.
+
+## Use
+
+### ocp vscode:
+
+A host writes one class and supplies one list. `exclude_keys` names the keywords
+it may not be told, because its surface decides them - the show signature is the
+superset of every host's, so a keyword one host owns is a keyword another has to
+refuse by name rather than ignore.
+
+```python
+comms = MyComms()
+session = Session(comms)                        # sets session cache to None
+config = Config(session, ("cad_width", "height"))
+show(objects)
+```
+
+What a host *persists* between sessions is its own business and needs no key
+list here: it answers with values, from `Comms.workspace_config()`. Which of the
+viewer's reported state counts as configuration - and so survives into the next
+show - is `keys.CONFIG`, derived from the vocabulary, because that set is a
+property of three-cad-viewer's state and not of any host's settings.
+
+## Dependencies
+
+`ocp-tessellate` for tessellation, and `three-cad-viewer` as a peer dependency of the JavaScript half. **No OCP provider is declared** — the same `OCP` namespace is supplied by `cadquery_ocp`, `cadquery_ocp_novtk` and conda's `OCP`, and naming one would break users of the other two. The host or the user chooses.
+
+## Licence
+
+Apache-2.0.

ocp_viewer_core-1.0.0/README.md

@@ -0,0 +1,64 @@
+# ocp-viewer-core
+
+The shared half of the OCP viewer ecosystem: one show suite, one tessellation, one set of config semantics, used by four viewers that each keep their own transport and their own settings storage.
+
+- **ocp_vscode** — the VS Code extension and its Python client
+- **ocp_viewer** — the standalone viewer, `python -m ocp_viewer`
+- **Jupyter CadQuery** — through cad-viewer-widget
+- **build123d Studio**
+
+Published as one project under one version to two registries: `ocp-viewer-core` on PyPI for the Python half, `ocp-viewer-core` on npm for the JavaScript half. The two are shipped and versioned together, so which version of the pair a host has is one question rather than two.
+
+## The idea
+
+Each host provides a `Comms` — a Python encoder and a JavaScript decoder, shipped as a pair — and a settings source. Everything above that is shared and knows nothing about which host it is running in. **No host is nameable inside this package**: no `port=`/`viewer=` pairs, no `is_jupyter_cadquery`, no environment sniffing, and no host name in a string. A conformance kit enforces that by running the shared half end to end over an in-memory loopback with no host at all.
+
+Per-host imports stay per host: `from ocp_vscode import show` beside `from build123d_studio import show`. A single universal import with the host discovered at runtime is deliberately not offered — it is how a `show()` once silently drew into somebody else's viewer.
+
+## Status
+
+Early development. Nothing here is published, and the API changes without notice until the first host adopts it.
+
+## Layout
+
+| path                        | what                                                                                                |
+| --------------------------- | --------------------------------------------------------------------------------------------------- |
+| `ocp_viewer_core/`          | the Python half                                                                                     |
+| `ocp_viewer_core/config.py` | the config keys, each mapped to the name three-cad-viewer knows it by, and the precedence over them |
+| `ocp_viewer_core/comms.py`  | the transport a host implements, and the session that caches what it answers                        |
+| `ocp_viewer_core/logo.py`   | the splash logo as measurable geometry, for a host's measurement backend                            |
+| `js/src/logo.js`            | the splash logo as tessellated data plus its config, for the renderer                                |
+| `js/`                       | the JavaScript half, published to npm                                                               |
+| `tests/`                    | including the conformance kit                                                                       |
+
+`ocp_viewer_core/__init__.py` is import-free by design: hosts import the submodule they need, so that importing the package never pulls in the tessellator or OCP.
+
+## Use
+
+### ocp vscode:
+
+A host writes one class and supplies one list. `exclude_keys` names the keywords
+it may not be told, because its surface decides them - the show signature is the
+superset of every host's, so a keyword one host owns is a keyword another has to
+refuse by name rather than ignore.
+
+```python
+comms = MyComms()
+session = Session(comms)                        # sets session cache to None
+config = Config(session, ("cad_width", "height"))
+show(objects)
+```
+
+What a host *persists* between sessions is its own business and needs no key
+list here: it answers with values, from `Comms.workspace_config()`. Which of the
+viewer's reported state counts as configuration - and so survives into the next
+show - is `keys.CONFIG`, derived from the vocabulary, because that set is a
+property of three-cad-viewer's state and not of any host's settings.
+
+## Dependencies
+
+`ocp-tessellate` for tessellation, and `three-cad-viewer` as a peer dependency of the JavaScript half. **No OCP provider is declared** — the same `OCP` namespace is supplied by `cadquery_ocp`, `cadquery_ocp_novtk` and conda's `OCP`, and naming one would break users of the other two. The host or the user chooses.
+
+## Licence
+
+Apache-2.0.

ocp_viewer_core-1.0.0/ocp_viewer_core/__init__.py

@@ -0,0 +1,125 @@
+"""Shared viewer logic for the OCP CAD viewers.
+
+The show pipeline, the configuration semantics, the render and camera policy,
+the measurement backend and the wire protocol, used by ocp_vscode, ocp_viewer,
+Jupyter CadQuery and build123d Studio. Each host supplies a transport and its
+own settings; everything above that is here.
+
+This module imports nothing. A host imports the submodule it needs, so that
+importing the package never loads the tessellator or OCP - `show`, `backend`
+and `measure` reach the kernel, and `comms`, `config`, `keys`, `state` and
+`websocket` do not.
+
+It also carries the universal import: `from ocp_viewer_core import show`
+works in every host's environment and resolves to the host that is meant -
+`host.py` says how that is decided. The resolution is lazy (PEP 562), so the
+paragraph above stays true: a bare import still loads nothing, a star import
+resolves at the import statement, and a named import on first access. The
+resolved names are the chosen host's own bound methods.
+"""
+
+#
+# Copyright 2026 Bernhard Walter
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from ._version import __version__
+
+# The shared vocabulary: the intersection of the hosts' public names,
+# measured 2026-08-16. Everything here exists in every host, so a script
+# using only these runs unchanged under any of them - which is what makes
+# the star import safe to write.
+__all__ = [
+    "__version__",
+    "combined_config",
+    "get_default",
+    "get_defaults",
+    "push_object",
+    "remove_object",
+    "reset_defaults",
+    "reset_show",
+    "save_screenshot",
+    "set_defaults",
+    "set_viewer_config",
+    "show",
+    "show_all",
+    "show_clear",
+    "show_object",
+    "show_objects",
+    "status",
+    "workspace_config",
+]
+
+# Names some hosts have and others honestly lack, because they are shaped by
+# the transport: a port means nothing to a sidecar, a sidecar means nothing
+# to a websocket. Importable by name from the chosen host; absent from
+# `__all__` so a star import never carries a name that may not exist. Asked
+# of a host that lacks them, the ImportError below names that host rather
+# than letting the name silently not work.
+#
+# This tuple is also the explicit list of *accepted* feature asymmetries
+# under the "all hosts behave the same" rule - anything host-specific that is
+# not a transport shape does not belong here, it belongs fixed.
+_HOST_ONLY = (
+    # websocket hosts (ocp_vscode, ocp_viewer): which viewer a port addresses
+    "get_port",
+    "set_port",
+    # jupyter_cadquery: the sidecar lifecycle its host process owns
+    "close_viewer",
+    "close_viewers",
+    "get_default_viewer",
+    "get_user_defaults",
+    "get_viewer",
+    "open_viewer",
+    "save_user_defaults",
+    "set_default_viewer",
+)
+
+
+def __getattr__(name):
+    """PEP 562: called only for names this module does not really have.
+
+    Restricted to the two published tuples. Delegating every unknown name
+    would make any typo - or any `hasattr` probe by tooling - import a host
+    and possibly prompt, which is a side effect no attribute miss should
+    have. The import of `host` lives here and not at the top so that a bare
+    `import ocp_viewer_core` keeps importing nothing.
+    """
+    if name in __all__ or name in _HOST_ONLY:
+        from . import host
+
+        viewer = host.chosen()
+        try:
+            value = getattr(viewer, name)
+        except AttributeError:
+            raise ImportError(
+                f"{name!r} exists in some hosts but not in {viewer.__name__}"
+            ) from None
+        # Written back as a real attribute, and not only as a cache. `show` is
+        # also a submodule of this package, and importing the chosen host - who
+        # imports `ocp_viewer_core.show` like every host - makes the import
+        # machinery set that submodule as this package's `show` attribute,
+        # *during* this call. A real attribute wins over `__getattr__`, so
+        # without this line the `from ocp_viewer_core import show` that
+        # triggered the resolution would bind the submodule, not the host's
+        # function: the import statement reads the attribute again after
+        # `__getattr__` returns.
+        globals()[name] = value
+        return value
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+def __dir__():
+    """Completion without side effects: listing names must not choose a host."""
+    return sorted(set(globals().keys()) | set(__all__) | set(_HOST_ONLY))

ocp_viewer_core-1.0.0/ocp_viewer_core/_version.py

@@ -0,0 +1,21 @@
+"""The package version, written by `make bump`.
+"""
+
+#
+# Copyright 2026 Bernhard Walter
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+__version__ = "1.0.0"  # DO NOT EDIT THIS DIRECTLY!  It is managed by bumpversion
+__version_info__ = tuple(int(p) for p in __version__.split("."))