Mimesis (/mɪˈmiːsɪs) is a robust data generator for Python that can produce a wide range of fake data in various languages. This tool is useful for populating testing databases, creating fake API endpoints, filling pandas DataFrames, generating JSON and XML files with custom structures, and anonymizing production data, among other purposes.

To install mimesis, simply use pip:

pip install mimesis

Mimesis is compatible with Python, including PyPy, version 3.8 or higher. The Mimesis 4.1.3 is the last release that accommodates Python 3.6 and 3.7.

To prevent unintended upgrades, it is highly advisable to always specify the version of mimesis that you are using by pinning it.

• Easy: Mimesis offers a simple design and clear documentation for easy data generation.
• Multilingual: Mimesis can generate data in multiple languages.
• Performance: Widely recognized as the fastest data generator among Python solutions.
• Data variety: Mimesis includes various data providers for names, addresses, phone numbers, email addresses, dates, times, and more, catering to different use cases.
• Country-specific data providers: Mimesis supports country-specific data providers for generating region-specific data.
• Extensibility: Developers can extend Mimesis by creating and integrating their own data providers.
• Generic data provider: Mimesis provides a single object that grants easy access to all available data providers in the library.
• Zero hard dependencies: Mimesis has no hard dependencies, eliminating the need for additional third-party libraries.
• Schema-based generators: Mimesis offers schema-based data generators to effortlessly produce data of any complexity.

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

It is divided into several sections:

• About Mimesis
• Quickstart
• Locales
• Data Providers
• Structured Data Generation
• Random and Seed
• Tricks and Tips
• API Reference
• Additional Information
• Changelog

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

The library is exceptionally user-friendly, and it only requires you to import a Data Provider object that corresponds to the desired data type.

For instance, the Person provider can be imported to access personal information, including name, surname, email, and other related fields:

>>> from mimesis import Person
>>> from mimesis.locales import Locale
>>> person = Person(Locale.EN)

>>> person.full_name()
'Brande Sears'

>>> person.email(domains=['example.com'])
'[email protected]'

>>> person.email(domains=['mimesis.name'], unique=True)
'[email protected]'

>>> person.telephone(mask='1-4##-8##-5##3')
'1-436-896-5213'

More about the other providers you can read in our documentation.

Mimesis presently encompasses 34 distinct locales, enabling users to specify the desired region and language when creating providers.

Here's how it operates practically:

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

>>> person_de = Person(locale=Locale.DE)
>>> person_en = Person(locale=Locale.EN)

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

>>> person_en.full_name(gender=Gender.MALE)
'Layne Gallagher'

Mimesis provides more than twenty data providers which can generate a broad range of data related to food, transportation, computer hardware, people, internet, addresses, and more.

See API Reference and Data Providers for more info.

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.

The creators of mimesis are not responsible for how you use the library or the data it generates. Mimesis is meant for testing purposes and should not be used for illegal activities.

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