> For the complete documentation index, see [llms.txt](https://wsocket.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wsocket.gitbook.io/docs/installation.md).

# Installation

Installation guide to WSocket

## Installing from PyPI

Install latest version or upgrade an already installed `WSocket` to the latest from PyPI.

```
pip install --upgrade wsocket
```

## Failture???

### Ensure you can run Python from the command line

Before you go any further, make sure you have Python and that the expected version is available from your command line. You can check this by running:

```
python --version
```

You should get some output like `Python 3.6.3`. If you do not have Python, please install the latest 3.x version from [python.org](https://python.org/) or refer to the [Installing Python](http://docs.python-guide.org/en/latest/starting/installation/) section of the Hitchhiker’s Guide to Python.

{% hint style="info" %}
Note 

If you’re a newcomer and you get an error like this:>>>

```
>>> python --version
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'python' is not defined
```

It’s because this command and other suggested commands in this tutorial are intended to be run in a *shell* (also called a *terminal* or *console*). See the Python for Beginners [getting started tutorial](https://opentechschool.github.io/python-beginners/en/getting_started.html#what-is-python-exactly) for an introduction to using your operating system’s shell and interacting with Python.
{% endhint %}

{% hint style="info" %}
Note&#x20;

If you’re using an enhanced shell like IPython or the Jupyter notebook, you can run system commands like those in this tutorial by prefacing them with a `!` character:

> ```
> In [1]: import sys
>         !{sys.executable} --version
> Python 3.6.3
> ```

It’s recommended to write `{sys.executable}` rather than plain `python` in order to ensure that commands are run in the Python installation matching the currently running notebook (which may not be the same Python installation that the `python` command refers to).
{% endhint %}

{% hint style="info" %}
Note&#x20;

Due to the way most Linux distributions are handling the Python 3 migration, Linux users using the system Python without creating a virtual environment first should replace the `python` command in this tutorial with `python3` and the `pip` command with `pip3` .If you get a permissions error, run it as administer (`sudo`)
{% endhint %}

{% hint style="info" %}
Note

Some users should replace the `python` command in this tutorial with `py` .
{% endhint %}

### Ensure you can run pip from the command line

Additionally, you’ll need to make sure you have [pip](https://packaging.python.org/key_projects/#pip) available. You can check this by running:

```
pip --version
```

If you installed Python from source, with an installer from [python.org](https://python.org/), or via [Homebrew](https://brew.sh/) you should already have pip. If you’re on Linux and installed using your OS package manager, you may have to install pip separately, see [Installing pip/setuptools/wheel with Linux Package Managers](https://packaging.python.org/guides/installing-using-linux-tools/).

If `pip` isn’t already installed, then first try to bootstrap it from the standard library:

```
python -m ensurepip --default-pip
```

If that still doesn’t allow you to run `pip`:

* Securely Download [get-pip.py](https://bootstrap.pypa.io/get-pip.py)
* Run `python get-pip.py`. This will install or upgrade pip. Additionally, it will install [setuptools](https://packaging.python.org/key_projects/#setuptools) and [wheel](https://packaging.python.org/key_projects/#wheel) if they’re not installed already.

{% hint style="warning" %}
Warning&#x20;

Be cautious if you’re using a Python install that’s managed by your operating system or another package manager. get-pip.py does not coordinate with those tools, and may leave your system in an inconsistent state. You can use `python get-pip.py --prefix=/usr/local/` to install in `/usr/local` which is designed for locally-installed software.
{% endhint %}

### Ensure pip, setuptools, and wheel are up to date

While `pip` alone is sufficient to install from pre-built binary archives, up to date copies of the `setuptools` and `wheel` projects are useful to ensure you can also install from source archives:

```
python -m pip install --upgrade pip setuptools wheel
```

### Then

Try to [install](/docs/installation.md#installing-from-pypi) again.

{% hint style="info" %}
Any question??? report us from [issues](https://github.com/Ksengine/WSocket/issues/new/)
{% endhint %}