<commit_before>.. image:: https://raw.githubusercontent.com/lk-geimfari/mimesis/master/media/logo_media.png
     :target: https://github.com/lk-geimfari/mimesis


--------------


.. image:: https://travis-ci.org/lk-geimfari/mimesis.svg?branch=master
     :target: https://travis-ci.org/lk-geimfari/mimesis

.. image:: https://ci.appveyor.com/api/projects/status/chj8huslvn6vde18?svg=true
     :target: https://ci.appveyor.com/project/lk-geimfari/mimesis

.. image:: https://readthedocs.org/projects/mimesis/badge/?version=latest
     :target: http://mimesis.readthedocs.io/?badge=latest

.. image:: https://codecov.io/gh/lk-geimfari/mimesis/branch/master/graph/badge.svg
     :target: https://codecov.io/gh/lk-geimfari/mimesis

.. image:: https://badge.fury.io/py/mimesis.svg
     :target: https://badge.fury.io/py/mimesis

.. image:: https://img.shields.io/badge/python-3.5%2C%203.6-brightgreen.svg
     :target: https://badge.fury.io/py/mimesis


**Mimesis** is a fast and easy to use library for Python programming
language, which helps generate synthetic data for a variety of purposes
in a variety of languages. This data can be particularly useful during
software development and testing. For example, it could be used to
populate a testing database, create beautiful JSON and XML files,
anonymize data taken from a production service, etc.

This library offers a number of advantages over other similar libraries:

-  Performance. Significantly `faster`_ than other similar libraries.
-  Completeness. Strives to provide many detailed providers that offer a
   variety of data generators.
-  Simplicity. Does not require any modules other than the Python
   standard library.

.. _faster: https://gist.github.com/lk-geimfari/e76c12eb3c9a8afbf796c706d4ba779d


Installation
------------

To install mimesis, simply use pip:

.. code:: text

    ➜  ~ pip install mimesis

also you can install it manually:

.. code:: text

    (env) ➜ git clone <EMAIL>:lk-geimfari/mimesis.git
    (env) ➜ cd mimesis/
    (env) ➜ make install



Documentation
-------------

| You can find the complete documentation on the `Read the Docs`_.
It is divided into several sections:

-  `Foreword`_
-  `Quickstart`_
-  `Advanced Usage`_
-  `API Reference`_<commit_msg>Fixed issue with readme on PyPi<commit_after>.. image:: https://raw.githubusercontent.com/lk-geimfari/mimesis/master/media/logo_media.png
     :target: https://github.com/lk-geimfari/mimesis


--------------


.. image:: https://travis-ci.org/lk-geimfari/mimesis.svg?branch=master
     :target: https://travis-ci.org/lk-geimfari/mimesis

.. image:: https://ci.appveyor.com/api/projects/status/chj8huslvn6vde18?svg=true
     :target: https://ci.appveyor.com/project/lk-geimfari/mimesis

.. image:: https://readthedocs.org/projects/mimesis/badge/?version=latest
     :target: http://mimesis.readthedocs.io/?badge=latest

.. image:: https://codecov.io/gh/lk-geimfari/mimesis/branch/master/graph/badge.svg
     :target: https://codecov.io/gh/lk-geimfari/mimesis

.. image:: https://badge.fury.io/py/mimesis.svg
     :target: https://badge.fury.io/py/mimesis

.. image:: https://img.shields.io/badge/python-3.5%2C%203.6-brightgreen.svg
     :target: https://badge.fury.io/py/mimesis


**Mimesis** is a fast and easy to use library for Python programming
language, which helps generate synthetic data for a variety of purposes
in a variety of languages. This data can be particularly useful during
software development and testing. For example, it could be used to
populate a testing database, create beautiful JSON and XML files,
anonymize data taken from a production service, etc.

This library offers a number of advantages over other similar libraries:

-  Performance. Significantly `faster`_ than other similar libraries.
-  Completeness. Strives to provide many detailed providers that offer a
   variety of data generators.
-  Simplicity. Does not require any modules other than the Python
   standard library.

.. _faster: https://gist.github.com/lk-geimfari/e76c12eb3c9a8afbf796c706d4ba779d


Installation
------------

To install mimesis, simply use pip:

.. code:: text

    ➜  ~ pip install mimesis

also you can install it manually:

.. code:: text

    (env) ➜ git clone git@github.com:lk-geimfari/mimesis.git
    (env) ➜ cd mimesis/
    (env) ➜ make install



Documentation
-------------

You can find the complete documentation on the `Read the Docs`_.

It is divided into several sections:

-  `Foreword`_
-  `Quickstart`_
-  `Advanced Usage`_
-  `API Reference`_
{'fraction_non_alphanumeric': 0.13134657836644592, 'fraction_numerical': 0.012362030905077263, 'mean_word_length': 3.455260570304818, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 28, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 1, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1002322', 'n_tokens_mistral': 1606, 'n_tokens_neox': 1521, 'n_words': 398}