Skip to main content

Mimesis: mock data for developers.

Project description

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 https://readthedocs.org/projects/mimesis/badge/?version=latest https://codecov.io/gh/lk-geimfari/mimesis/branch/master/graph/badge.svg https://badge.fury.io/py/mimesis.svg https://img.shields.io/badge/python-3.5%2C%203.6-brightgreen.svg

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.

Installation

To install mimesis, simply use pip:

➜  ~ pip install mimesis

also you can install it manually:

(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:

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

Getting started

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

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

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
mimesis-2.1.0-py3-none-any.whl (2.4 MB) Copy SHA256 hash SHA256 Wheel py3 Jun 17, 2018
mimesis-2.1.0.tar.gz (2.4 MB) Copy SHA256 hash SHA256 Source None Jun 17, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page