ptzagk2 / mimesis Goto Github PK

Mimesis is fast and extremely easy to use Python package, which helps generate 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.

To install mimesis, simply use pip:

[env] ~ ⟩ pip install mimesis

This library is really easy to use and everything you need is just import an object which represents a 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 in our documentation.

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.

Let's take a look how it works:

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

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

It is divided into several sections:

• Foreword
• Getting Started
• Tips and Tricks
• API Reference
• Contributing
• Changelog

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

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.

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