Skip to content

Commit bfb0f5a

Browse files
author
Elliot Boschwitz
authored
Updated pip installation instructions (#472)
* updated windows * udpated macos * added pip linux disclaimer
1 parent 6e121f4 commit bfb0f5a

3 files changed

Lines changed: 44 additions & 55 deletions

File tree

doc/installation/macos.md

Lines changed: 13 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,26 @@
11
# macOS Installation
22

3-
## Supported OS versions:
4-
* macOS (x64) 10.12+
3+
## Supported OS Versions
4+
mssql-cli supports macOS (x64) 10.12 and up.
55

6-
## Installation via pip
7-
Python 2.7 is pre-installed on macOS.
8-
```shell
6+
## Installing mssql-cli
7+
mssql-cli is installed using `pip`:
8+
```sh
99
# Install pip
10-
$ sudo easy_install pip
10+
sudo easy_install pip
1111

1212
# Update pip
13-
$ sudo pip install --upgrade pip
13+
python -m pip install --upgrade pip
1414

1515
# Install mssql-cli
16-
$ sudo pip install mssql-cli
16+
sudo pip install mssql-cli
1717

1818
# Run mssql-cli
19-
$ mssql-cli
19+
mssql-cli
2020
```
2121

22-
## Installation with daily preview build
23-
Daily preview builds are dropped in our storage account. To install the latest available version of mssql-cli, use the below command:
24-
```shell
25-
# Install pip
26-
$ sudo easy_install pip
27-
28-
# Update pip
29-
$ sudo pip install --upgrade pip
30-
31-
# Install latest preview build of mssql-cli
32-
$ sudo pip install --pre --no-cache --extra-index-url https://mssqlcli.blob.core.windows.net/daily/whl mssql-cli
33-
```
34-
35-
## Uninstallation via pip
36-
```shell
37-
$ sudo pip uninstall mssql-cli
22+
## Uninstalling mssql-cli
23+
Use `pip` to remove mssql-cli:
24+
```sh
25+
sudo pip uninstall mssql-cli
3826
```

doc/installation/pip.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ $ sudo pip install mssql-cli --ignore-installed six
6868
```
6969

7070
# Linux Installation
71+
> **Installing on Linux using `pip` is no longer recommended.** Please consult the [Linux Installation Guide](https://github.com/dbcli/mssql-cli/blob/master/doc/installation/linux.md) for installing mssql-cli with `apt-get` or `yum`.
7172
7273
On Linux, Python 2.7 is generally pre-installed. There are two prerequisite packages to run mssql-cli on Linux: libunwind and libicu.
7374

doc/installation/windows.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,53 @@
11
# Windows Installation
22

3-
## Supported OS versions:
3+
## Requirements
4+
5+
### Supported OS Versions
6+
mssql-cli is supported on Windows with:
47
* Windows (x86/x64) 8.1
58
* Windows (x86/x64) 10
69
* Windows Server 2012+
710

11+
### Python Installation
12+
813
Python is required for installation of mssql-cli and is not installed by default on Windows. To install Python, follow these instructions:
914
1. Open the latest Python installer package from [here](https://www.python.org/downloads/).
1015
2. Select **Add Python [Version] to PATH** option before installation. Python must be in the PATH environment variable.
1116
3. Install Python.
1217

13-
**Note:** If Python was installed into the "Program Files" directory, you may need to open the command prompt as an administrator for the above command to succeed.
18+
> If Python was installed into the "Program Files" directory, you may need to open the command prompt as an administrator for the above command to succeed.
1419
15-
Once Python is installed and in the PATH environment variable, open a command prompt, and install mssql-cli using the below command.
20+
Proceed to the next section once Python is installed and in the PATH environment variable.
1621

17-
## Installation via pip
18-
```shell
19-
C:\> pip install mssql-cli
20-
```
21-
Or, use the following command if you encounter a launcher error:
22-
```shell
23-
C:\> python -m pip install mssql-cli
24-
```
22+
## Installing mssql-cli
23+
> Note: your path to Python may be different from the listed command. For example, instead of `python` you may need to call `python3`.
2524
26-
## Installation with daily preview build
27-
Daily preview builds are dropped in our storage account. To install the latest available version of mssql-cli, use the below command:
28-
```shell
29-
C:\> pip install --pre --no-cache --extra-index-url https://mssqlcli.blob.core.windows.net/daily/whl mssql-cli
25+
mssql-cli is installed using `pip` on Windows:
26+
```sh
27+
python -m pip install mssql-cli
3028
```
3129

32-
## Uninstallation via pip
33-
```shell
34-
C:\> pip uninstall mssql-cli
30+
## Uninstalling mssql-cli
31+
Uninstall mssql-cli using `pip`:
32+
```sh
33+
pip uninstall mssql-cli
3534
```
3635

37-
## Installation behind a proxy
36+
## Installation Behind a Proxy
3837
Set two environment variables:
39-
```shell
40-
C:\>set http_proxy=domain\username:password@proxy_server:port
41-
C:\>set https_proxy=domain\username:password@proxy_server:port
38+
```sh
39+
set http_proxy=domain\username:password@proxy_server:port
40+
set https_proxy=domain\username:password@proxy_server:port
4241
```
43-
If the Password contains special characters like @,$,! (e.g. Password: P@ssword) then replace the special characters by their hex code equivalents with % prefix like this:
44-
@==>%40
45-
$==>%24
46-
!==>%21
47-
Example: username:p%40ssword@proxy_server:port
42+
If the Password contains special characters like `@,$,!` (e.g. `password:p@ssword`) then replace the special characters by their hex code equivalents with `%` prefix, as exemplified below:
43+
* `@`: `%40`
44+
* `$`: `%24`
45+
* `!`: `%21`
46+
47+
Example: `username:p%40ssword@proxy_server:port`
4848

49-
after this steps try install again
49+
You may attempt installation after completing these steps:
5050

51-
```shell
52-
C:\>pip install mssql-cli
51+
```sh
52+
pip install mssql-cli
5353
```

0 commit comments

Comments
 (0)