Skip to content

Latest commit

 

History

History
94 lines (53 loc) · 2.08 KB

DEV_SETUP.rst

File metadata and controls

94 lines (53 loc) · 2.08 KB

Getting started with aioelasticsearch

There you will find full description to get aioelasticsearch library up and ready.
For this example Ubuntu 18.04/macOS X and Python 3.6 were used.

The main steps:

  1. Clone this github repo.

  2. Install and configure docker for this project:

    On Linux:

    sudo apt install docker.io
    systemctl start docker
    systemctl enable docker

    After that, you need to add your current user to the 'docker' group:

    usermod -aG docker $USER

    On macOS X:

    Follow instructions described here.

  3. You might also want to check the docker version:

    docker --version
  4. To verify that docker is configured correctly, run following command:

    docker ps -a

    If it doesn't raise any errors, you can proceed with next steps.

  5. Create and activate virtual env in downloaded folder:

    if you use virtualenv:

    virtualenv -p python3 <envname>
    source <envname>/bin/activate

    if you use Anaconda:

    conda create -n <envname>
    conda activate <envname>

    Also you can use another method, like venv.

  6. Install required packages from requirements.txt:

    pip install -r requirements.txt
  7. To be sure that aioelasticsearch is in development mode run following command:

    pip install -e .
  8. Great! Now you can run some tests, to see if everything works correctly:

    On Linux:

    pytest tests

    On macOS X:

    pytest --local-docker
    Note: the first time you will have to wait while docker downloads the ElasticSearch image (~600 MB).
    This may take some time (usually up to 5 minutes).
    All further test runs will take less time (usually up to 3 minutes).