/mimesis

Mimesis is a fast and easy to use library for Python, which helps generate fake data for a variety of purposes in a variety of languages.

Primary LanguagePythonMIT LicenseMIT

Mimesis - Fake Data Generator

https://raw.githubusercontent.com/lk-geimfari/mimesis/master/media/logo_media.png



https://travis-ci.org/lk-geimfari/mimesis.svg?branch=master https://ci.appveyor.com/api/projects/status/chj8huslvn6vde18?svg=true Documentation Status

Mimesis is fast and easy to use library, which helps generate the big volumes of fake data for a variety of purposes in a variety of languages. The fake 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 and etc.

Features

  • Custom providers
  • Generic data provider
  • More than 33 locales
  • More than 21 data providers
  • Data generation by the schema
  • Romanization of Cyrillic data
  • Built-In country-specific data providers

Installation

To install mimesis, simply use pip:

[env] ~ ⟩ pip install mimesis

Getting started

This library is really easy to use and everything you need is just import an object which represents type of data you need (we call such object Provider).

In example below we import provider Person, which represents data related to personal information, such as name, surname, email and etc:

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

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

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

>>> person.telephone()
'1-408-855-5063'

>>> person.identifier(mask='####/##-#')
'2714/48-4'

More about the other providers you can read here.

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:

>>> 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'

Documentation

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

It is divided into several sections:

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

How to Contribute

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

License

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

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.