Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,31 @@

A [Jupyter](https://jupyter.org/install) environment (compatible with JupyterLab ≥ 4.0.0).

The [Infrastructure Manager (IM)](https://imdocs.readthedocs.io/en/devel/gstarted.html) client must be installed and configured, an open-source virtual infrastructure provisioning tool for multi-Clouds.
The [Infrastructure Manager (IM)](https://imdocs.readthedocs.io/en/devel/gstarted.html) client must be configured, an open-source virtual infrastructure provisioning tool for multi-Clouds.

## 📦 Installation

If you already have a JupyterLab environment, install APRICOTLab with:

```bash
python -m pip install apricot
```

Then start JupyterLab:

```bash
jupyter lab
```

The Python package installs the runtime dependencies used by the IPython magics, including the IM client, `IPython`, `tabulate`, `requests`, and `PyJWT`.

You can check that JupyterLab detects the prebuilt extension with:

```bash
jupyter labextension list
```

When installing from a published wheel, Node.js and `jlpm` are not required.

## ✨ IPython Magics for Infrastructure Management

Expand Down Expand Up @@ -112,6 +136,7 @@ This will launch a JupyterLab instance with APRICOT pre-installed.

> Note: Node.js is required for building the extension.
> Note: The `jlpm` command is JupyterLab's pinned version of [yarn](https://yarnpkg.com/) that is installed with JupyterLab.
> Note: These steps are only needed when installing from the source repository for development.

```bash
# Clone the repository
Expand All @@ -126,6 +151,9 @@ jupyter labextension develop . --overwrite

# Build the extension
jlpm build

# Start JupyterLab
jupyter lab
```

You can run the extension in watch mode:
Expand Down
17 changes: 16 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ classifiers = [
"Programming Language :: Python :: 3.12",
]
dependencies = [
"IM-client",
"ipython>=8.0.0",
"tabulate",
"requests",
"PyJWT",
]
dynamic = ["version", "description", "authors", "urls", "keywords"]

Expand All @@ -36,6 +41,16 @@ fields = ["description", "authors", "urls"]
artifacts = ["apricot/labextension"]
exclude = [".github", "binder"]

[tool.hatch.build.targets.sdist.force-include]
"apricot_magics" = "apricot_magics"
"resources" = "resources"

[tool.hatch.build.targets.wheel]
packages = ["apricot", "apricot_magics"]

[tool.hatch.build.targets.wheel.force-include]
"resources" = "resources"

[tool.hatch.build.targets.wheel.shared-data]
"apricot/labextension" = "share/jupyter/labextensions/apricot"
"install.json" = "share/jupyter/labextensions/apricot/install.json"
Expand Down Expand Up @@ -74,4 +89,4 @@ before-build-npm = [
before-build-python = ["jlpm clean:all"]

[tool.check-wheel-contents]
ignore = ["W002"]
ignore = ["W002", "W009", "W010"]
48 changes: 0 additions & 48 deletions resources/deployable_templates/ansible_tasks.yaml

This file was deleted.

99 changes: 0 additions & 99 deletions resources/deployable_templates/argo.yaml

This file was deleted.

73 changes: 0 additions & 73 deletions resources/deployable_templates/docker_cluster.yaml

This file was deleted.

80 changes: 0 additions & 80 deletions resources/deployable_templates/galaxy.yaml

This file was deleted.

Loading
Loading