aprasanna/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_
Contributing_
Changelog_

You can improve it by sending pull requests to this repository.

.. _Read the Docs: http://mimesis.readthedocs.io
.. _Foreword: http://mimesis.readthedocs.io/foreword.html
.. _Quickstart: http://mimesis.readthedocs.io/quickstart.html
.. _API Reference: http://mimesis.readthedocs.io/api.html
.. _Advanced Usage: http://mimesis.readthedocs.io/advanced.html
.. _Contributing: http://mimesis.readthedocs.io/contributing.html
.. _Changelog: http://mimesis.readthedocs.io/changelog.html

Getting started

That’s library is really easy to use and a simple usage example is given
below:

.. code:: python

>>> from mimesis import Person
>>> person = Person('en')

>>> person.full_name()
'Antonetta Garrison'

>>> person.occupation()
'Backend Developer'

Locales

Mimesis currently includes support for 33 different locales_. You can
specify a locale when creating providers and they will return data that
is appropriate for the language or country associated with that locale:

.. code:: python

>>> from mimesis import Person
>>> from mimesis.enums import Gender

>>> de = Person('de')
>>> pl = Person('pl')

>>> de.full_name(gender=Gender.FEMALE)
'Sabrina Gutermuth'

>>> pl.full_name(gender=Gender.MALE)
'Światosław Tomankiewicz'

.. _locales: http://mimesis.readthedocs.io/quickstart.html#supported-locales

How to Contribute

Take a look at contributing guidelines_.
Check for open issues or open a fresh issue to start a discussion
around a feature idea or a bug.
Fork the repository on GitHub to start making your changes to the
your_branch branch.
Add yourself to the list of contributors_.
Send a pull request and bug the maintainer until it gets merged and
published.

.. _contributing guidelines: https://github.com/lk-geimfari/mimesis/blob/master/CONTRIBUTING.rst
.. _contributors: https://github.com/lk-geimfari/mimesis/blob/master/CONTRIBUTORS.rst

License

Mimesis is licensed under the MIT License. See LICENSE_ for more
information.

.. _LICENSE: https://github.com/lk-geimfari/mimesis/blob/master/LICENSE

Disclaimer

The authors assume no responsibility for how you use this library data
generated by it. This library is designed only for developers with good
intentions. Do not use the data generated with Mimesis for illegal
purposes.