Mimesis: The Fake Data Generator
--------------------------------
|
.. image:: https://raw.githubusercontent.com/lk-geimfari/mimesis/master/.github/images/logo.png
:target: https://github.com/lk-geimfari/mimesis
|
Description
-----------
.. image:: https://github.com/lk-geimfari/mimesis/actions/workflows/test.yml/badge.svg?branch=master
:target: https://github.com/lk-geimfari/mimesis/actions/workflows/test.yml?query=branch%3Amaster
:alt: Github Actions Test
.. image:: https://readthedocs.org/projects/mimesis/badge/?version=latest
:target: https://mimesis.name/en/latest/
:alt: Documentation Status
.. image:: https://img.shields.io/pypi/v/mimesis?color=bright-green
:target: https://pypi.org/project/mimesis/
:alt: PyPi Version
.. image:: https://img.shields.io/pypi/dm/mimesis
:target: https://pypi.org/project/mimesis/
:alt: PyPI - Downloads
.. image:: https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%20pypy-brightgreen
:target: https://pypi.org/project/mimesis/
:alt: Python version
Mimesis (`/mɪˈmiːsɪs <https://mimesis.name/en/master/about.html#what-does-name-mean>`_) 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.
Installation
------------
To install mimesis, simply use pip:
.. code:: bash
pip install mimesis
To work with Mimesis on Python versions 3.8 and 3.9, the final compatible version is Mimesis 11.1.0.
Install this specific version to ensure compatibility.
Features
--------
- **Multilingual**: Supports 35 different locales.
- **Extensibility**: Supports custom data providers and custom field handlers.
- **Ease of use**: Features a simple design and clear documentation for straightforward data generation.
- **Performance**: Widely recognized as the fastest data generator among Python solutions.
- **Data variety**: Includes various data providers designed for different use cases.
- **Schema-based generators**: Offers schema-based data generators to effortlessly produce data of any complexity.
- **Intuitive**: Great editor support. Fully-typed, thus autocompletion almost everywhere.
Documentation
-------------
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`_
- `Integration with Pytest`_
- `Integration with factory_boy`_
- `Tricks and Tips`_
- `API Reference`_
- `Additional Information`_
- `Changelog`_
You can improve it by sending pull requests to this repository.
Usage
-----
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 <https://mimesis.name/en/latest/api.html#person>`_ provider can be imported to access personal information, including name, surname, email, and other related fields:
.. code:: python
>>> from mimesis import Person
>>> from mimesis.locales import Locale
>>> person = Person(Locale.EN)
>>> person.full_name()
'Brande Sears'
>>> person.email(domains=['example.com'])
'roccelline1878@example.com'
>>> person.email(domains=['mimesis.name'], unique=True)
'f272a05d39ec46fdac5be4ac7be45f3f@mimesis.name'
>>> person.telephone(mask='1-4##-8##-5##3')
'1-436-896-5213'
You can learn more about other providers and locales in our `documentation`_.
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.
.. _Locales: https://mimesis.name/en/master/locales.html
.. _LICENSE: https://github.com/lk-geimfari/mimesis/blob/master/LICENSE
.. _API Reference: https://mimesis.name/en/master/api.html
.. _Data Providers: https://mimesis.name/en/master/getting_started.html#data-providers
.. _Read the Docs: https://mimesis.name/en/master/
.. _About Mimesis: https://mimesis.name/en/latest/about.html
.. _Quickstart: https://mimesis.name/en/master/quickstart.html
.. _Structured Data Generation: https://mimesis.name/en/master/schema.html
.. _Random and Seed: https://mimesis.name/en/master/random_and_seed.html
.. _Tricks and Tips: https://mimesis.name/en/master/tips.html
.. _Additional Information: https://mimesis.name/en/master/index.html#additional-information
.. _Changelog: https://mimesis.name/en/master/index.html#changelog
.. _documentation: https://mimesis.name/en/latest/getting_started.html#data-providers
.. _contributing guidelines: https://github.com/lk-geimfari/mimesis/blob/master/CONTRIBUTING.rst
.. _contributors: https://github.com/lk-geimfari/mimesis/blob/master/CONTRIBUTORS.rst
.. _Integration with Pytest: https://mimesis.name/en/master/pytest_plugin.html
.. _Integration with factory_boy: https://mimesis.name/en/master/factory_plugin.html
Raw data
{
"_id": null,
"home_page": "https://github.com/lk-geimfari/mimesis",
"name": "mimesis",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "data, datascince, database, dummy, fake, faker, fixtures, generate, mimesis, mock, schema, dataframe, populate, testing, pandas, polars, pytest, factory, factory_boy",
"author": "Isaak Uchakaev",
"author_email": "hey@isaak.dev",
"download_url": "https://files.pythonhosted.org/packages/fa/0e/481bd61c4e162dd88c6f282f5b07c8a17165d55b2a3517d3d388a8f763f0/mimesis-16.0.0.tar.gz",
"platform": null,
"description": "Mimesis: The Fake Data Generator\n--------------------------------\n\n|\n\n.. image:: https://raw.githubusercontent.com/lk-geimfari/mimesis/master/.github/images/logo.png\n :target: https://github.com/lk-geimfari/mimesis\n\n|\n\nDescription\n-----------\n\n.. image:: https://github.com/lk-geimfari/mimesis/actions/workflows/test.yml/badge.svg?branch=master\n :target: https://github.com/lk-geimfari/mimesis/actions/workflows/test.yml?query=branch%3Amaster\n :alt: Github Actions Test\n\n.. image:: https://readthedocs.org/projects/mimesis/badge/?version=latest\n :target: https://mimesis.name/en/latest/\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/pypi/v/mimesis?color=bright-green\n :target: https://pypi.org/project/mimesis/\n :alt: PyPi Version\n\n.. image:: https://img.shields.io/pypi/dm/mimesis\n :target: https://pypi.org/project/mimesis/\n :alt: PyPI - Downloads\n\n.. image:: https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%20pypy-brightgreen\n :target: https://pypi.org/project/mimesis/\n :alt: Python version\n\n\nMimesis (`/m\u026a\u02c8mi\u02d0s\u026as <https://mimesis.name/en/master/about.html#what-does-name-mean>`_) 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.\n\nInstallation\n------------\n\n\nTo install mimesis, simply use pip:\n\n.. code:: bash\n\n pip install mimesis\n\nTo work with Mimesis on Python versions 3.8 and 3.9, the final compatible version is Mimesis 11.1.0.\nInstall this specific version to ensure compatibility.\n\nFeatures\n--------\n\n- **Multilingual**: Supports 35 different locales.\n- **Extensibility**: Supports custom data providers and custom field handlers.\n- **Ease of use**: Features a simple design and clear documentation for straightforward data generation.\n- **Performance**: Widely recognized as the fastest data generator among Python solutions.\n- **Data variety**: Includes various data providers designed for different use cases.\n- **Schema-based generators**: Offers schema-based data generators to effortlessly produce data of any complexity.\n- **Intuitive**: Great editor support. Fully-typed, thus autocompletion almost everywhere.\n\nDocumentation\n-------------\n\nYou can find the complete documentation on the `Read the Docs`_.\n\nIt is divided into several sections:\n\n- `About Mimesis`_\n- `Quickstart`_\n- `Locales`_\n- `Data Providers`_\n- `Structured Data Generation`_\n- `Random and Seed`_\n- `Integration with Pytest`_\n- `Integration with factory_boy`_\n- `Tricks and Tips`_\n- `API Reference`_\n- `Additional Information`_\n- `Changelog`_\n\nYou can improve it by sending pull requests to this repository.\n\nUsage\n-----\n\nThe library is exceptionally user-friendly, and it only requires you to import a **Data Provider** object that corresponds to the desired data type.\n\nFor instance, the `Person <https://mimesis.name/en/latest/api.html#person>`_ provider can be imported to access personal information, including name, surname, email, and other related fields:\n\n.. code:: python\n\n >>> from mimesis import Person\n >>> from mimesis.locales import Locale\n >>> person = Person(Locale.EN)\n\n >>> person.full_name()\n 'Brande Sears'\n\n >>> person.email(domains=['example.com'])\n 'roccelline1878@example.com'\n\n >>> person.email(domains=['mimesis.name'], unique=True)\n 'f272a05d39ec46fdac5be4ac7be45f3f@mimesis.name'\n\n >>> person.telephone(mask='1-4##-8##-5##3')\n '1-436-896-5213'\n\n\nYou can learn more about other providers and locales in our `documentation`_.\n\n\nHow to Contribute\n-----------------\n\n1. Take a look at `contributing guidelines`_.\n2. Check for open issues or open a fresh issue to start a discussion\n around a feature idea or a bug.\n3. Fork the repository on GitHub to start making your changes to the\n *your_branch* branch.\n4. Add yourself to the list of `contributors`_.\n5. Send a pull request and bug the maintainer until it gets merged and\n published.\n\n\nLicense\n-------\n\nMimesis is licensed under the MIT License. See `LICENSE`_ for more\ninformation.\n\n.. _Locales: https://mimesis.name/en/master/locales.html\n.. _LICENSE: https://github.com/lk-geimfari/mimesis/blob/master/LICENSE\n.. _API Reference: https://mimesis.name/en/master/api.html\n.. _Data Providers: https://mimesis.name/en/master/getting_started.html#data-providers\n.. _Read the Docs: https://mimesis.name/en/master/\n.. _About Mimesis: https://mimesis.name/en/latest/about.html\n.. _Quickstart: https://mimesis.name/en/master/quickstart.html\n.. _Structured Data Generation: https://mimesis.name/en/master/schema.html\n.. _Random and Seed: https://mimesis.name/en/master/random_and_seed.html\n.. _Tricks and Tips: https://mimesis.name/en/master/tips.html\n.. _Additional Information: https://mimesis.name/en/master/index.html#additional-information\n.. _Changelog: https://mimesis.name/en/master/index.html#changelog\n.. _documentation: https://mimesis.name/en/latest/getting_started.html#data-providers\n.. _contributing guidelines: https://github.com/lk-geimfari/mimesis/blob/master/CONTRIBUTING.rst\n.. _contributors: https://github.com/lk-geimfari/mimesis/blob/master/CONTRIBUTORS.rst\n.. _Integration with Pytest: https://mimesis.name/en/master/pytest_plugin.html\n.. _Integration with factory_boy: https://mimesis.name/en/master/factory_plugin.html\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Mimesis: Fake Data Generator.",
"version": "16.0.0",
"project_urls": {
"Documentation": "https://mimesis.name",
"Homepage": "https://github.com/lk-geimfari/mimesis",
"Repository": "https://github.com/lk-geimfari/mimesis"
},
"split_keywords": [
"data",
" datascince",
" database",
" dummy",
" fake",
" faker",
" fixtures",
" generate",
" mimesis",
" mock",
" schema",
" dataframe",
" populate",
" testing",
" pandas",
" polars",
" pytest",
" factory",
" factory_boy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d4bce47c3925fa6e8758c8fb66215baf6c41122c73cfa37c61c69f9787e5a94f",
"md5": "ae395db3f047c7303cf2c2c2dd5b9249",
"sha256": "adeebdd6c39b84fcf5c232cb42a931cfdaf541248a4b34382029e90d357c35dd"
},
"downloads": -1,
"filename": "mimesis-16.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae395db3f047c7303cf2c2c2dd5b9249",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 4478474,
"upload_time": "2024-04-04T00:51:52",
"upload_time_iso_8601": "2024-04-04T00:51:52.578468Z",
"url": "https://files.pythonhosted.org/packages/d4/bc/e47c3925fa6e8758c8fb66215baf6c41122c73cfa37c61c69f9787e5a94f/mimesis-16.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fa0e481bd61c4e162dd88c6f282f5b07c8a17165d55b2a3517d3d388a8f763f0",
"md5": "c5177884d74b8a27f0a77748a084d7ec",
"sha256": "0837e4063a62e15b4ac73ae5fdef37c93c5ba0e02c9e5681481c1dfde407d4fe"
},
"downloads": -1,
"filename": "mimesis-16.0.0.tar.gz",
"has_sig": false,
"md5_digest": "c5177884d74b8a27f0a77748a084d7ec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 4440245,
"upload_time": "2024-04-04T00:51:55",
"upload_time_iso_8601": "2024-04-04T00:51:55.420888Z",
"url": "https://files.pythonhosted.org/packages/fa/0e/481bd61c4e162dd88c6f282f5b07c8a17165d55b2a3517d3d388a8f763f0/mimesis-16.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 00:51:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lk-geimfari",
"github_project": "mimesis",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mimesis"
}
JSON
