Metadata-Version: 2.3
Name: macroverse
Version: 0.2.0
Summary: Jupyverse deployment
Keywords: jupyter
Author: David Brochart
Author-email: David Brochart <david.brochart@gmail.com>
License: The MIT License (MIT)
         
         Copyright (c) 2025 David Brochart
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
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: Programming Language :: Python :: Implementation :: CPython
Requires-Dist: jupyverse[jupyterlab,auth]>=0.10.31
Requires-Dist: cyclopts>=4.4.3,<5.0.0
Requires-Dist: holm>=0.7.3
Requires-Dist: pyyaml>=6.0.3,<7.0.0
Requires-Dist: httpx>=0.28.1,<1.0.0
Requires-Dist: structlog
Requires-Dist: pydantic
Requires-Dist: psutil
Requires-Dist: types-psutil
Requires-Dist: types-pyyaml
Requires-Python: >=3.10
Project-URL: Homepage, https://github.com/davidbrochart/macroverse
Description-Content-Type: text/markdown

# Macroverse

[![Build Status](https://github.com/davidbrochart/macroverse/workflows/test/badge.svg)](https://github.com/davidbrochart/macroverse/actions)

[Jupyverse](https://github.com/jupyter-server/jupyverse) deployment.

## Installation

Install [micromamba](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html),
create an environment an install `macroverse` and `nginx`:

```bash
micromamba create -n macroverse
micromamba activate macroverse
micromamba install nginx pip
pip install macroverse
```

## Usage

### Process containers

In this configuration, Jupyter kernel servers run in processes on the same machine.

Enter in the terminal:

```bash
macroverse --open-browser
```

This should open a browser window with a list of environments.
Click on `New environment` and enter this `Environment YAML`:

```yaml
name: my-env
channels:
  - conda-forge
dependencies:
  - ipykernel
  - matplotlib
  - numpy
```

Click `Submit` and wait until the environment is created. Then click `Start server` next to your environment name.
This should change the environment name into a link. If you click on it, this should open JupyterLab in a new tab.

### Docker containers

You must have Docker installed. In this configuration, Jupyter kernel servers run in Docker containers.

Enter in the terminal:

```bash
macroverse --open-browser --container docker
```

The UX is the same as for process containers.
