Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
manzt committed Oct 20, 2024
1 parent 4e75a73 commit 53a86ce
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,29 @@ uvx juv
# Usage: juv [uvx flags] <COMMAND>[@version] [PATH]
#
# Commands:
# lab: Launch JupyterLab
# notebook: Launch Jupyter Notebook
# nbclassic: Launch Jupyter Notebook Classic
# init: Initialize a new notebook
# add: Add dependencies to the notebook
# lab: Launch notebook/script in Jupyter Lab
# notebook: Launch notebook/script in Jupyter Notebook
# nbclassic: Launch notebook/script in Jupyter Notebook Classic
#
# Examples:
# uvx juv lab script.py
# uvx juv nbclassic script.py
# uvx juv notebook existing_notebook.ipynb
# uvx juv --python=3.8 [email protected] script.ipynb
# juv init foo.ipynb
# juv add foo.ipynb numpy pandas
# juv lab foo.ipynb
# juv nbclassic script.py
# juv --python=3.8 [email protected] foo.ipynb
```

`juv` has three main commands:
`juv` has five main commands:

- `juv init` initializes a new notebook
- `juv add` adds dependencies to an existing notebook
- `juv lab` launches a Jupyter Lab session
- `juv notebook` launches a classic notebook session
- `juv nbclassic` launches a classic notebook session

These commands accept a single argument: the path to the notebook or script to
launch. A script will be converted to a notebook before launching.
A script will be converted to a notebook before launching.

```sh
uvx juv lab script.py # creates script.ipynb
Expand Down

0 comments on commit 53a86ce

Please sign in to comment.