Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Useful commands for Elasticsearch

Project Description

A command-line tool and API for various Elasticsearch operations.

Install

pip install elastic-companion

Note: The 1.X versions of elastic-companion support Elasticsearch 1.X and the 5.X versions support Elasticsearch 5.X. This is similar to the versioning of the official library

Commands

To see the list of commands, use the -h or --help flag.

Each command has a corresponding Python module that can be imported and used as an API rather than from the command-line.

Developing

If you are using Docker and Docker Compose, then you don’t need to fiddle with python and pip manually. Otherwise, see below.

Download Python 3, then:

$ pyvenv-3.X venv
$ source venv/bin/activate
$ pip3 install -r requirements.txt
$ ./cli.py -h

On Ubuntu, there’s a bit of an issue with pip3 and the above might not work. Then:

$ pyvenv-3.X venv --without-pip
$ source venv/bin/activate
$ cd venv
$ wget https://bootstrap.pypa.io/get-pip.py
$ python3 get-pip.py
$ cd ..
$ pip3 install -r requirements.txt
$ ./cli.py -h

Testing

Use nose:

$ nosetests

or:

$ docker-compose run --rm companion nosetests

Deploying

You need access to the pypi repository first, then it’s just a matter of:

$ python setup.py sdist bdist_wheel
$ twine upload dist/*

Release History

This version
History Node

5.0.0

History Node

1.4.0

History Node

1.3.0

History Node

1.2.0

History Node

1.1.0

History Node

1.0.0

History Node

0.9.6

History Node

0.9.5

History Node

0.9.4

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
elastic_companion-5.0.0-py3-none-any.whl
(15.7 kB) Copy SHA256 Hash SHA256
Wheel py3 May 9, 2017
elastic-companion-5.0.0.tar.gz
(12.1 kB) Copy SHA256 Hash SHA256
Source None May 9, 2017

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers DreamHost DreamHost Log Hosting