# Installation

### Usual PIP installation

```
pip install esgissue-client
```

### PIP installation from GitHub

```
pip install -e git@github.com:ES-DOC/esdoc-errata-client.git@master#egg=esdoc-errata-client
```

### Installation from GitHub

1. Clone [our GitHub project](http://github.com/ES-DOC/esdoc-errata-client/):

   > ```
   > git clone git@github.com:ES-DOC/esdoc-errata-client.git@master
   > ```
2. Run the `setup.py`:

   > ```
   > cd esdoc-errata-client
   > python setup.py install
   > ```
3. The `esgissue` command-line is ready.

   > <mark style="color:red;">Warning</mark>
   >
   > To run `esgissue` you have to be logged into a machine with internet access.

### Dependencies and requirements

Linux distribution with Python 2.6+ is required. `esgissue` uses the following basic Python libraries. Ensure that your Python environment includes:

> * [os](https://docs.python.org/2/library/os.html)
> * [collections](https://docs.python.org/2/library/collections.html)
> * [fnmatch](https://docs.python.org/2/library/fnmatch.html)
> * [linecache](https://docs.python.org/fr/2.7/library/linecache.html)
> * [getpass](https://docs.python.org/fr/2.7/library/getpass.html)
> * [sys](https://docs.python.org/2/library/sys.html)
> * [re](https://docs.python.org/2/library/re.html)
> * [platform](https://docs.python.org/fr/2.7/library/platform.html)
> * [argparse](https://docs.python.org/2/library/argparse.html)
> * [logging](https://docs.python.org/2/library/logging.html)
> * [ConfigParser](https://docs.python.org/2/library/configparser.html)
> * [datetime](https://docs.python.org/2/library/datetime.html)
> * [uuid](https://docs.python.org/2/library/uuid.html)
> * [string](https://docs.python.org/2/library/string.html)
> * [json](https://docs.python.org/2/library/json.html)
> * [textwrap](https://docs.python.org/2/library/textwrap.html)

Some required libraries are not included in most Python distributions. Please install them using the usual PIP command:

> * [jsonschema](https://pypi.python.org/pypi/jsonschema)
> * [requests](https://pypi.python.org/pypi/requests/2.11.1)
> * [pbkdf2](https://www.dlitz.net/software/python-pbkdf2/)
> * [pyDes](http://twhiteman.netfirms.com/des.html)

```
pip install <pkg_name>
```
