Skip to content

Commit b987b39

Browse files
committed
Add setup doc
1 parent f18f32d commit b987b39

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

docs/setup.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
sidebar_position: 2
3+
sidebar_label: Setup
4+
hide_title: true
5+
---
6+
7+
### Installation
8+
9+
The currently supported python version is ***Python 3.8.**** You need to have this version of python in your OS to continue any of the following steps.
10+
11+
**Method 1: with pipx**
12+
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.
14+
15+
First, [Install pipx](https://pypa.github.io/pipx/installation/). Then run
16+
17+
```bash
18+
$ pipx install chk
19+
```
20+
21+
**Method 2: with pip (globally)**
22+
23+
Alternatively you can install with `pip` like other regular python package following these step. However, it will install the package globally.
24+
25+
```bash
26+
$ python3 -m pip install -U pip # upgrade pip
27+
$ python3 -m pip install -U chk
28+
```
29+
30+
**Method 3: with pip (locally)**
31+
32+
To install under a seperate environment, that don't change your global package space. Install under a virtual env.
33+
34+
```bash
35+
$ python3 -m venv .venv # create virtual environemnt
36+
$ source .venv/bin/activate # active virtual environemnt
37+
$ pip install -U pip # upgrade pip
38+
$ pip install -U chk
39+
```
40+
41+
---
42+
### Upgrade
43+
44+
If you have installed with **pipx** then use following to upgrade to latest released version.
45+
46+
```bash
47+
$ pipx upgrade chk
48+
```
49+
50+
Otherwise, if **pip** was used to install then same process given above should work for upgrade as well.
51+
52+
---
53+
### Platform support
54+
55+
For now this tool is developed and tested on **macOS** only. We are working hard to make it available on Linux platform.
56+
57+
---
58+
### Stability
59+
60+
Current stability for this tool is _Pre - Alpha_

0 commit comments

Comments
 (0)