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
+35-9Lines changed: 35 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,19 @@
2
2
title: Setup
3
3
---
4
4
5
-
### Installation
5
+
## User installation guide
6
+
7
+
This section describe the process on installation when you intent to use **chkware**.
8
+
9
+
### chkware toolset installation
6
10
7
11
8
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.
9
13
10
14
11
15
**Method 1: with pipx**
12
16
13
-
The best way to setup any python app is manage it via [pipx](https://pypa.github.io/pipx/). Pipx is a standred pypi python application manager.
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.
14
18
15
19
First, [Install pipx](https://pypa.github.io/pipx/installation/). Then run
16
20
@@ -21,45 +25,60 @@ $ pipx install chk
21
25
Then use as following
22
26
23
27
```bash
24
-
$ chk http SomeFile.chk
28
+
$ chk http some_file.chk
25
29
```
26
30
27
31
**Method 2: with pip (globally)**
28
32
29
33
Alternatively you can install with `pip` like other regular python package following these step. However, it will install the package globally.
30
34
31
35
```bash
32
-
$ python3 -m pip install -U pip # upgrade pip
33
36
$ python3 -m pip install -U chk
34
37
```
35
38
36
39
Then use as following
37
40
38
41
```bash
39
-
$ python3 -m chk http SomeFile.chk
42
+
$ chk http some_file.chk
40
43
```
41
44
42
45
**Method 3: with pip (locally)**
43
46
44
-
To install under a seperate environment, that don't change your global package space. Install under a virtual env.
47
+
To install under a separate environment, that don't change your global package space. You should install under a virtual environment.
$ source .venv/bin/activate # active virtual environemnt
49
-
$ pip install -U pip # upgrade pip
50
52
$ pip install -U chk
51
53
```
52
54
53
55
Then use as following
54
56
55
57
```bash
58
+
$ chk http some_file.chk
59
+
```
60
+
61
+
**Method 4: with pip (locally) from git**
62
+
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:
Read more about this process in [‘pip install’ From a Git Repository](https://adamj.eu/tech/2019/03/11/pip-install-from-a-git-repository/)
78
+
60
79
---
61
80
62
-
### Upgrade
81
+
### chkware toolset upgrade
63
82
64
83
If you have installed with **pipx** then use following to upgrade to latest released version.
65
84
@@ -68,3 +87,10 @@ $ pipx upgrade chk
68
87
```
69
88
70
89
Otherwise, if **pip** was used to install then same process given above should work for upgrade as well.
90
+
91
+
---
92
+
### chkware IDE extension installation
93
+
94
+
**chkware** will have your favorite IDE / editor integration so that it is easy for you to write `.chk` files. We are currently actively developing a Visual Studio Code extension. We will update this section with usage, once it's released.
0 commit comments