Skip to content

add documentation for using uv tool install as an alternative to pipx install #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gbeane merged 1 commit into from
Jan 16, 2026
Merged

add documentation for using uv tool install as an alternative to pipx install #268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 9 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,19 @@ This section describes how to install JABS as an end user. Developers should see

**Note:** The first time you run JABS, it may take a few minutes to initialize. Startup time for subsequent runs will be substantially faster.

### Install with pipx (Recommended)
### Install with pipx or uv (Recommended)

The easiest way to install JABS is using [pipx](https://pipx.pypa.io/), which installs Python applications in isolated environments:
The easiest way to install JABS is using [pipx](https://pipx.pypa.io/) or [uv](https://docs.astral.sh/uv/), which install Python applications in isolated environments:

```bash
# Using pipx
pipx install jabs-behavior-classifier

# OR using uv
uv tool install jabs-behavior-classifier
```

This automatically creates a virtual environment and makes the JABS commands available system-wide. After installing with pipx, you can run JABS from any terminal.
Both commands automatically create a virtual environment and make the JABS commands available system-wide. After installation, you can run JABS from any terminal.

```bash
# launch the JABS GUI
Expand All @@ -54,9 +58,9 @@ jabs
jabs-init --help
```

### Install with uvx
### Run with uvx (No Installation Required)

Alternatively, you can use `uvx` to run JABS without installation:
Alternatively, you can use `uvx` to run JABS without permanently installing it:

```bash
uvx --from jabs-behavior-classifier jabs
Expand Down
6 changes: 0 additions & 6 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,6 @@ jabs = "jabs.scripts.gui_entrypoint:main"
"jabs-project-merge" = "jabs.scripts.merge_projects:main"
"jabs-cli" = "jabs.scripts.cli:main"

# Poetry-specific config kept for src/ layout and Poetry's own dev group
[tool.poetry]
packages = [
{ include = "jabs", from = "src" },
]

[build-system]
requires = ["uv_build>=0.7.19,<0.8.0"]
build-backend = "uv_build"
Expand Down