Metadata-Version: 2.4
Name: jupytercad
Version: 3.4.1
License: BSD 3-Clause License
        
        Copyright (c) 2023, JupyterCad contributors
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.8
Requires-Dist: jupyter-collaboration-ui<3,>=2
Requires-Dist: jupyter-collaboration<5,>=4
Requires-Dist: jupyter-docprovider<3,>=2
Requires-Dist: jupyter-server-ydoc<3,>=2
Requires-Dist: jupytercad-app==3.4.1
Requires-Dist: jupytercad-core==3.4.1
Requires-Dist: jupytercad-lab==3.4.1
Requires-Dist: jupyterlab<5,>=4.5.1
Description-Content-Type: text/markdown

# JupyterCAD - A JupyterLab extension for collaborative 3D geometry modeling.

[![lite-badge]][lite] [![docs-badge]][docs]

[lite-badge]: https://jupyterlite.rtfd.io/en/latest/_static/badge.svg
[lite]: https://jupytercad.github.io/JupyterCAD/
[docs-badge]: https://readthedocs.org/projects/jupytergis/badge/?version=latest
[docs]: https://jupytercad.readthedocs.io/

JupyterCAD is a JupyterLab extension for 3D geometry modeling with collaborative editing support. It is designed to allow multiple people to work on the same file at the same time, and to facilitate discussion and collaboration around the 3D shapes being created.

JupyterCAD has support for FreeCAD files, which makes it easy to import and export models from FreeCAD. It also has a range of features for creating and manipulating 3D shapes, including a variety of primitives, transformations, and Boolean operations.

![jupytercad](https://raw.githubusercontent.com/jupytercad/JupyterCAD/refs/heads/main/docs/source/assets/jupytercad-screenshot.png#gh-dark-mode-only)
![jupytercad](https://raw.githubusercontent.com/jupytercad/JupyterCAD/refs/heads/main/docs/source/assets/jupytercad-light-ss.png#gh-light-mode-only)

## Requirements

- JupyterLab >= 4.0.0
- freecad (optional)

## Installation

You can install JupyterCAD using conda/mamba (this installs freecad automatically):

```bash
mamba install -c conda-forge jupytercad
```

Or using pip:

```bash
pip install jupytercad
```

Once you have installed the extension, you should be able to open the CAD viewer in JupyterLab and create 3D shapes!

Additionally, you can install `jupytercad-freecad` and edit `.FCStd` files in JupyterLab.

## Use JupyterCAD in Notebook.link

The easiest way to get a deployment with JupyterCAD live is using [Notebook.link](https://notebook.link).
Simply install `jupytercad-lite` in your Notebook.link environment.

Click on this link to try it out: https://notebook.link/github.com/jupytercad/JupyterCAD

## Deploying JupyterCAD with JupyterLite

You can run JupyterCAD entirely in the browser using **JupyterLite**.

1. **Create a repository** using the [xeus-lite-demo](https://github.com/jupyterlite/xeus-lite-demo) template.
2. In your fork, edit `environment.yml` and add:
   ```yaml
   - jupytercad-lite
   ```
3. **Add your jcad and example files** under the `content/` directory of your repository.
   These files will be available directly inside your Lite deployment.
4. **Enable GitHub Pages** under _Settings → Pages_ for your repository.
5. Once the build completes, your Lite deployment will be live at:
   ```
   https://<username>.github.io/<repo-name>/
   ```

This provides a lightweight, fully browser-based JupyterCAD environment — no server required.

> [!IMPORTANT]
> Collaboration is **not yet supported** in JupyterLite static deployments.


## Documentation

Check out the JupyterCAD documentation on ReadTheDocs! https://jupytercad.readthedocs.io

## Contributing

JupyterCAD is an open-source project, and contributions are always welcome. If you would like to contribute to JupyterCAD, please fork the repository and submit a pull request.

See [CONTRIBUTING](https://github.com/jupytercad/JupyterCAD/blob/main/CONTRIBUTING.md) for dev installation instructions.

## License

JupyterCAD is licensed under the BSD 3-Clause License. See the LICENSE file for more information.
