You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/02-setup.md
+22-56Lines changed: 22 additions & 56 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,19 +2,11 @@
2
2
title: Setup
3
3
---
4
4
5
-
##User installation guide
5
+
### Install `chkware` toolset with Pipx
6
6
7
-
This section describe the process on installation when you intent to use **chkware**.
7
+
This section describe the installation process for [`chkware`](https://github.com/chkware/cli). The currently supported python version is **_Python 3.10.x_** You need to have this version of python in your OS to continue.
8
8
9
-
### chkware toolset installation
10
-
11
-
12
-
The currently supported python version is **_Python 3.10.x_** You need to have this version of python in your OS to continue any of the following steps.
13
-
14
-
15
-
**Method 1: with pipx**
16
-
17
-
The best way to setup any python app is manage it via [pipx](https://pypa.github.io/pipx/). Pipx is a standard pypi python application manager.
9
+
The best way to setup any python app is manage it via [pipx](https://pypa.github.io/pipx/). Pipx is a standard PyPi python application manager.
18
10
19
11
First, [Install pipx](https://pypa.github.io/pipx/installation/). Then run
20
12
@@ -28,62 +20,36 @@ Then use as following
28
20
$ chk http some_file.chk
29
21
```
30
22
31
-
**Method 2: with pip (globally)**
32
-
33
-
Alternatively you can install with `pip` like other regular python package following these step. However, it will install the package globally.
34
-
35
-
```bash
36
-
$ python3 -m pip install -U chk
37
-
```
38
-
39
-
Then use as following
40
-
41
-
```bash
42
-
$ chk http some_file.chk
43
-
```
44
-
45
-
**Method 3: with pip (locally)**
23
+
### `chkware` toolset upgrade
46
24
47
-
To install under a separate environment, that don't change your global package space. You should install under a virtual environment.
25
+
If you have installed with _pipx_ then use following to upgrade to latest released version.
$ source .venv/bin/activate # active virtual environemnt
52
-
$ pip install -U chk
53
-
```
54
-
55
-
Then use as following
56
-
57
-
```bash
58
-
$ chk http some_file.chk
28
+
$ pipx upgrade chk
59
29
```
60
30
61
-
**Method 4: with pip (locally) from git**
31
+
Otherwise, if _pip_ was used to install then same process given above should work for upgrade as well.
62
32
63
-
To install latest version or a specific version from source code, under a separate environment, that don't change your global package space. Try following:
0 commit comments