Skip to content

update installation docs and skill installer for PyPI #7

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
anish749 merged 3 commits into from
Mar 29, 2026
Merged

update installation docs and skill installer for PyPI #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c8df05
update installation docs and skill installer for PyPI package
anish749 Mar 29, 2026
6200146
readme: use uv tool install as primary install method
anish749 Mar 29, 2026
33c391e
readme: show both uv and pip install options
anish749 Mar 29, 2026
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: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,24 @@ The architectural pattern — a long-lived daemon process, CLI-driven interactio

## Installation

Requires Python 3.10+ and [uv](https://docs.astral.sh/uv/).
Requires Python 3.10+.

```bash
git clone <repo-url> && cd claude-nbexec
uv sync
uv tool install claude-nbexec
```

Or with pip:

```bash
pip install claude-nbexec
```

### Install the Claude Code skill

Clone the repo and run the skill installer:

```bash
git clone https://github.com/anish749/claude-nbexec.git && cd claude-nbexec
./install-skill.sh
```

Expand Down
11 changes: 10 additions & 1 deletion install-skill.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,21 @@
set -euo pipefail

REPO_DIR="$(cd "$(dirname "$0")" && pwd)"
NBEXEC_PATH="$REPO_DIR/.venv/bin/nbexec"
SKILL_SRC="$REPO_DIR/.claude/skills/nbexec/SKILL.md.template"
CLAUDE_DIR="${CLAUDE_CONFIG_DIR:-$HOME/.claude}"
CLAUDE_DIR="${CLAUDE_DIR%/}"
SKILL_DST="$CLAUDE_DIR/skills/nbexec"

# Find nbexec: prefer PATH, fall back to local .venv
if command -v nbexec &>/dev/null; then
NBEXEC_PATH="$(command -v nbexec)"
elif [ -x "$REPO_DIR/.venv/bin/nbexec" ]; then
NBEXEC_PATH="$REPO_DIR/.venv/bin/nbexec"
else
echo "Error: nbexec not found. Install with: pip install claude-nbexec" >&2
exit 1
fi

mkdir -p "$SKILL_DST"
sed "s|__NBEXEC_PATH__|$NBEXEC_PATH|g" "$SKILL_SRC" > "$SKILL_DST/SKILL.md"
echo "Installed skill to $SKILL_DST/SKILL.md (nbexec path: $NBEXEC_PATH)"
Loading