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
This section describe the installation process for [*CHKware*](https://github.com/chkware/cli). The currently supported python version is **_Python 3.13.x_**. You need to have this version of python in your OS to continue.
5
+
This section describe the installation process for [_CHKware_](https://github.com/chkware/cli). The currently supported python version is **_Python 3.13.x_**. You need to have this version of python in your OS to continue.
`pipx` is a standard PyPI python application manager. `pipx` creates separate virtual environment for given installable package. So, your system have less side effect.
16
16
17
17
:::
18
18
19
19
The best way is to setup CHKware with [_pipx_](https://pipx.pypa.io/stable/). Follow the steps:
If you have _Python 3.13.x_ installed, then you already have `pip` installed by default.
34
+
`pip` gets installed with Python. You should use [updated pip version](https://pip.pypa.io/en/stable/installation/#upgrading-pip).
35
+
36
+
:::note
37
+
38
+
`python` command should be automatically setup on install. Based on OS it also can be `py` (windows), `python3` or `python3.13` (macOS / Linux) based on the package manager that was used to install Python.
33
39
34
40
:::
35
-
:::info
41
+
42
+
:::tip[about virtual environment]
36
43
37
44
It is **RECOMMENDED** to use a virtual environment when using via `pip`.
38
45
39
46
For windows users, please follow [**this nice article**](https://realpython.com/python-virtual-environments-a-primer/) to create and use virtual environment.
40
47
41
48
:::
42
-
:::warning
43
49
44
-
`python` command below assumes it's 3.13.x version. Based on OS it also can be `py`, `python3` or `python3.13` based on the package manager that was used to install.
3. Install CHKware cli in the virtual environment.
72
111
73
-
```shell
74
-
pip install -U chk
75
-
```
112
+
```shell
113
+
pip install -U chk
114
+
```
115
+
116
+
> To upgrade to the next released version, run the same command.
117
+
118
+
### Update _CHKware_ cli
119
+
120
+
#### pipx
121
+
122
+
If CHkware was installed with _pipx_ then to upgrade to latest released version.
123
+
124
+
```shell
125
+
pipx upgrade chk
126
+
```
127
+
128
+
#### pip
76
129
77
-
> To upgrade to the next released version, run the same command.
130
+
If CHkware was installed with _pip_ then to upgrade to latest released version.
78
131
79
-
### Update *CHKware* cli
132
+
:::info
80
133
81
-
- If CHkware was installed with_pipx_ then to upgrade to latest released version.
134
+
[Activate the virtual environment](#install-chkware-cli-with-pip) from step 2 before running following command.
82
135
83
-
```shell
84
-
pipx upgrade chk
85
-
```
136
+
:::
86
137
87
-
- If CHkware was installed with _pip_ then to upgrade to latest released version follow [Install *CHKware* cli with Pip](#install-chkware-cli-with-pip) step 2 and step 3.
138
+
```shell
139
+
pip install -U chk
140
+
```
88
141
89
142
---
90
143
91
-
### Install edge version of *CHKware* cli[Advance users]
144
+
### [Advance users]Install edge version of _CHKware_ cli
92
145
93
146
You can always install a tagged version directly from git
0 commit comments