Skip to content

Add venv instructions #143

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add venv instructions #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67b810c
Add instructions for Python virtual environment
S0AndS0 May 4, 2025
d80adba
Ignore `uv` lock file
S0AndS0 May 4, 2025
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ venv/
ENV/
env.bak/
venv.bak/
uv.lock

# Spyder project settings
.spyderproject
Expand Down
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,27 @@ Use setup.py to install vimdoc in the usual way. On most systems, this is:
python setup.py build
sudo python setup.py install

Or use `venv` manager

uv venv
uv pip install setuptools
uv run setup.py config
uv run setup.py build
uv run setup.py install

... And add wrapper script to `PATH` accessible directory;

```bash
_wrapper="${HOME}/.local/bin/vimdoc";

tee "${_wrapper}" 1>/dev/null <<EOF
#!/usr/bin/env bash
uv run "${PWD}/.venv/bin/vimdoc" "\${@}"
EOF

chmod u+x "${_wrapper}";
```

Execution
---------

Expand Down