Getting Started#

Using pip#

Setup#

To install the SDK you will need access to our python repository before you can pip install the sdk.

You can do this in multiple ways:

  • export a environment variable: PIP_EXTRA_INDEX_URL

export PIP_EXTRA_INDEX_URL=https://partners:[password]@repo.eyeontext.com/repository/eyeontext-pypi/simple
  • Using pip

pip3 config set global.extra-index-url https://partners:[password]@repo.eyeontext.com/repository/eyeontext-pypi/simple

Installing#

The SDK#

To install the base package, the english language and entities and a community license run the following:

pip3 install eot-wowool-sdk eot-wowool-domain-english-entity eot-wowool-community-license

Domains#

Format: pip3 install eot-wowool-domain-[language]-[domain]

pip3 install eot-wowool-domain-english-entity

Ex: pip3 install eot-wowool-domain-english-entity

See available domains: Domains

Testing#

Running the driver requesting entities:

wow -p "english,entity" -i "John Smith works for EyeOnText in Antwerp."

Note

On some platforms it has to compile the tokenizer, this may take a while but it will only do it once.

Using Docker#

Login into the eyeontext docker repository

docker login https://docker.eyeontext.com -u partners

You will be asked for the ‘partners’ password, we will gladly give it to you. Email : info@eyeontext.com

Run the docker container and share a folder from the host OS.

docker run -v [folder]:/shared/ -it docker.eyeontext.com/eot/sdk:latest bash

Note

[folder] should be the full path of the folder you want to share from your host inside the container

Unix#

docker run -v `pwd`:/eotws/ -it docker.eyeontext.com/eot/sdk:latest bash

MacOS M1#

MacOS M1: Add the platform to avoid a warning : –platform=linux/amd64

docker run --platform=linux/amd64 -v `pwd`:/eotws/ -it docker.eyeontext.com/eot/sdk:latest bash

Windows#

docker run -v C:\eotws:/eotws/ -it docker.eyeontext.com/eot/sdk:latest bash

Windows WSL#

The Ubuntu 20.04 version installed uses python3.8 but the SDK requires >= python3.9.

Python3.9#

To install python3.9 inside the WSL follow these instructions

sudo apt -y update && sudo apt -y upgrade && sudo add-apt-repository ppa:deadsnakes/ppa && sudo apt update && sudo apt-get -y  install python3.9 libpython3.9 python3-pip
sudo update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.9 1
pip3 config set global.extra-index-url https://partners:[password]@repo.eyeontext.com/repository/eyeontext-pypi/simple

Then add the Path to the CLI that have been installed.

export PATH=$PATH:${HOME}/.local/bin
source  ${HOME}/.bashrc

Python3.10#

To install python3.10 inside the WSL follow these instructions

sudo su
apt -y update && sudo apt -y upgrade && sudo add-apt-repository ppa:deadsnakes/ppa && sudo apt update && sudo apt-get -y  install python3.10 libpython3.10 python3-pip python3.10-distutils patchelf python3.10-dev
update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.10 1
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py && python3.10 get-pip.py
pip3 config set global.extra-index-url https://partners:[password]@repo.eyeontext.com/repository/eyeontext-pypi/simple

Then add the Path to the CLI that have been installed.

export PATH=$PATH:${HOME}/.local/bin
source  ${HOME}/.bashrc
export EOT_NEXUS_USERNAME=partners
export EOT_NEXUS_PASSWORD=[password]

One you have the new python version installed you can follow the pip install instructions

Testing#

pip3 install eot-wowool-sdk eot-wowool-domain-english-entity eot-wowool-community-license rich
wow -p english,entity -i "John Smith works for EyeOnText."