Metadata-Version: 2.1
Name: elasticsearch-faker
Version: 0.0.5
Summary: elasticsearch-faker is a CLI tool to generate fake data for Elasticsearch.
Home-page: https://github.com/thombashi/elasticsearch-faker
Author: Tsuyoshi Hombashi
Author-email: tsuyoshi.hombashi@gmail.com
License: MIT License
Project-URL: Source, https://github.com/thombashi/elasticsearch-faker
Project-URL: Tracker, https://github.com/thombashi/elasticsearch-faker/issues
Keywords: elasticsearch,faker
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Terminals
Requires-Python: >=3.5
Description-Content-Type: text/x-rst
Requires-Dist: click (<9,>=6.2)
Requires-Dist: elasticsearch (<8,>=7.0.5)
Requires-Dist: envinfopy (<1,>=0.0.3)
Requires-Dist: Faker (<9,>=1.0.8)
Requires-Dist: Jinja2 (<3,>=2.8)
Requires-Dist: loguru (<1,>=0.4.1)
Requires-Dist: Pygments (<3,>=2.2.0)
Requires-Dist: tqdm (<5,>=4.19.5)
Provides-Extra: buildexe
Requires-Dist: pyinstaller (>=4.3) ; extra == 'buildexe'
Provides-Extra: test
Requires-Dist: mock ; extra == 'test'
Requires-Dist: pytest (>=6.0.1) ; extra == 'test'
Requires-Dist: pytest-md-report (>=0.1) ; extra == 'test'
Requires-Dist: pytest-mock ; extra == 'test'

.. contents:: **elasticsearch-faker**
   :backlinks: top
   :depth: 2


Summary
============================================
`elasticsearch-faker` is a CLI tool to generate fake data for Elasticsearch.

.. image:: https://github.com/thombashi/elasticsearch-faker/workflows/Tests/badge.svg
    :target: https://github.com/thombashi/elasticsearch-faker/actions?query=workflow%3ATests
    :alt: Linux/macOS/Windows CI status


Installation
============================================

Installation: pip
------------------------------
::

    pip install elasticsearch-faker

Installation: dpkg (Ubuntu)
--------------------------------------------

1. Navigate to `Releases page <https://github.com/thombashi/elasticsearch-faker/releases>`__
2. Download the latest ``deb`` package
3. Install with ``dpkg -i`` command


Usage
============================================


Command help
----------------------------------------------
::

    Usage: elasticsearch-faker [OPTIONS] COMMAND [ARGS]...

      Faker for Elasticsearch

    Options:
      --version                       Show the version and exit.
      --debug                         For debug print.
      -q, --quiet                     Suppress execution log messages.
      -v, --verbose                   [x>=0]
      --locale [ar_EG|zh_CN|ka_GE|fr_FR|hi_IN|ko_KR|bg_BG|ne_NP|en_CA|nl_NL|ar_PS|en_US|el_GR|tr_TR|lt_LT|de_DE|no_NO|pt_BR|uk_UA|ja_JP|dk_DK|es_ES|pl_PL|sl_SI|it_IT|pt_PT|lv_LV|cs_CZ|fi_FI|fa_IR|hu_HU|ro_RO|en_AU|hr_HR|bs_BA|en_GB|zh_TW|en_NZ|ru_RU|sv_SE|es_MX|ar_SA|et_EE]
                                      Specify localization for fake data. Defaults
                                      to en_US.
      --seed INTEGER
      -h, --help                      Show this message and exit.

    Commands:
      generate    Generate fake data and put it to Elasticsearch
      provider
      show-stats
      validate    Check that a faker template file is well formed.
      version     Show version information

      Issue tracker: https://github.com/thombashi/elasticsearch-faker/issues

::

    Usage: elasticsearch-faker generate [OPTIONS] HOST

      Generate fake data and put it to Elasticsearch

    Options:
      --index NAME           Name of an index to create. Defaults to test_index.
      --mapping PATH         Path to a mapping file.
      --template PATH        Path to a faker template file.
      -n, --num-doc INTEGER  Number of generating docs. Using bulk API if the
                             value equals or greater than two. Defaults to 500.
      --bulk-size INTEGER    Number of docs for a single bulk API call. Defaults
                             to 200.
      --delete-index         Delete the index if already exists before generating
                             docs.
      -j, --jobs INTEGER     Number of jobs. Defaults to 1.
      --stdin                Read a faker template from stdin.
      --dry-run              Do no harm.
      -h, --help             Show this message and exit.

      Issue tracker: https://github.com/thombashi/elasticsearch-faker/issues


Dependencies
============================================
- Elasticsearch 7 or newer
- Python 3.5+
- `Python package dependencies (automatically installed) <https://github.com/thombashi/elasticsearch-faker/network/dependencies>`__


