Skip to content

Commit

Permalink
Document new install method using pipx instead of pip
Browse files Browse the repository at this point in the history
  • Loading branch information
pronovic committed Jun 11, 2023
1 parent d8de523 commit 95d0ea6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
1 change: 1 addition & 0 deletions Changelog
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Version 0.7.1 unreleased

* Add explicit dependency on pyyaml for use by uvicorn.
* Document new install method using pipx instead of pip.

Version 0.7.0 11 Jun 2023

Expand Down
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,14 @@ environment, etc.

The platform is distributed at GitHub. To install the software, download the `.whl`
file for the [latest release](https://github.com/pronovic/vplan/releases/latest),
and install it using `pip`, like:
and install it using [pipx](https://pypa.github.io/pipx/), like:

```
$ pip install vplan-0.6.0-py3-none-any.whl
$ pipx install --force --include-deps ./vplan-0.7.1-py3-none-any.whl
```

> On Debian, I install pipx using: `apt-get install pipx --no-install-suggests --no-install-recommends`
Next, configure the platform. Download the configuration bundle for the latest
release. Extract the tar file to your user configuration directory:

Expand Down Expand Up @@ -138,12 +140,14 @@ working.

The process is similar to installing. Download the `.whl` file for
the [latest release](https://github.com/pronovic/vplan/releases/latest), and install it
using `pip`, like:
using [pipx](https://pypa.github.io/pipx/), like:

```
$ pip install --force-reinstall vplan-0.6.0-py3-none-any.whl
$ pipx install --force --include-deps ./vplan-0.7.1-py3-none-any.whl
```

> On Debian, I install pipx using: `apt-get install pipx --no-install-suggests --no-install-recommends`
Reload configuration and restart the systemd service::

```
Expand Down

0 comments on commit 95d0ea6

Please sign in to comment.