Metadata-Version: 2.4
Name: jupytergis
Version: 0.14.1
Summary: Collaborative GIS extension for JupyterLab
Project-URL: Homepage, https://github.com/geojupyter/jupytergis
Project-URL: Documentation, https://jupytergis.readthedocs.io
Project-URL: Repository, https://github.com/geojupyter/jupytergis.git
Project-URL: Issues, https://github.com/geojupyter/jupytergis/issues
License: BSD 3-Clause License
        
        Copyright (c) 2023, JupyterGIS 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.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
Classifier: Topic :: Scientific/Engineering :: GIS
Requires-Python: >=3.10
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: jupytergis-core==0.14.1
Requires-Dist: jupytergis-lab==0.14.1
Requires-Dist: jupytergis-qgis==0.14.1
Requires-Dist: jupyterlab>=4.5.1
Description-Content-Type: text/markdown

<p align="center"><img width="100" src="https://raw.githubusercontent.com/geojupyter/jupytergis/main/packages/base/style/icons/logo.svg"></p>
<h1 align="center">JupyterGIS - A JupyterLab extension for collaborative GIS</h1>

[![lite-badge]][lite] [![docs-badge]][docs] [![jupytergis-badge]][marketplace]

[lite-badge]: https://jupyterlite.rtfd.io/en/latest/_static/badge.svg
[lite]: https://jupytergis.readthedocs.io/en/latest/lite/lab/index.html?path=france_hiking.jGIS/
[docs-badge]: https://readthedocs.org/projects/jupytergis/badge/?version=latest
[docs]: https://jupytergis.readthedocs.io
[jupytergis-badge]: https://labextensions.dev/api/badge/jupytergis?metric=downloads&leftColor=%23555&rightColor=%23F37620&style=flat
[marketplace]: https://labextensions.dev/extensions/jupytergis

![jupytergis](https://raw.githubusercontent.com/geojupyter/jupytergis/main/jupytergis.png)

## Features

- **Collaborative GIS Environment**: Work together on geographic data projects in real-time.
- **QGIS File Support**: Load, visualize, and manipulate QGIS project files (`.qgs`, `.qgz`), and other GIS data formats.
- **Interactive Maps**: Render interactive maps and geospatial visualizations within Jupyter notebooks using the JupyterGIS Python API.

## [🪄 Try JupyterGIS now in Notebook.link! ✨](https://notebook.link/github/geojupyter/jupytergis/lab/?path=examples%2Ffrance_hiking.jGIS)

This demo runs a JupyterLite instance entirely in your browser with WebAssembly! 🤯

Powered by [Notebook.link](https://notebook.link) and [JupyterLite](https://jupyterlite.readthedocs.io/en/stable/?badge=latest).
Please note that [JupyterGIS' real-time collaboration features are not yet supported in JupyterLite](https://jupyterlite.readthedocs.io/en/latest/howto/configure/rtc.html).

## Installation

### Prerequisites

- JupyterLab (version 3.0 or higher)
- (OPTIONAL) QGIS installed on your system and its Python modules available in the PATH. e.g. `mamba install --channel conda-forge qgis`

### Installing JupyterGIS

#### From PyPI

```bash
python -m pip install jupytergis
```

#### From conda-forge

JupyterGIS is also packaged and distributed on [conda-forge](https://github.com/conda-forge/jupytergis-packages-feedstock).

To install and add JupyterGIS to a project with [`pixi`](https://pixi.sh/), from the project directory run

```
pixi add jupytergis
```

and to install into a particular conda environment with [`mamba`](https://mamba.readthedocs.io/), in the activated environment run

```
mamba install --channel conda-forge jupytergis
```

#### With Docker

```bash
docker run -p 8888:8888 ghcr.io/geojupyter/jupytergis:latest
```

Replace `latest` with a specific version number if you prefer.
Docker build source is at <https://github.com/geojupyter/jupytergis-docker>.

## Deploying JupyterGIS with JupyterLite

You can run JupyterGIS 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
   - jupytergis-lite
   ```
3. **Add your data and jGIS 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 JupyterGIS environment — no server required.

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

## Documentation

https://jupytergis.readthedocs.io

## Contributing

We welcome contributions from the community! To contribute:

- Fork the repository
- Make a dev install of JupyterGIS
- Create a new branch
- Make your changes
- Submit a pull request

For more details, check out our [CONTRIBUTING.md](https://github.com/geojupyter/jupytergis/blob/main/CONTRIBUTING.md).

## License

JupyterGIS is licensed under the BSD 3-Clause License. See [LICENSE](./LICENSE) for more information.
