<p align="center">
<a href="https://github.com/lk-geimfari/mimesis"><img src="https://raw.githubusercontent.com/lk-geimfari/mimesis/master/.github/images/logo.png" alt="Mimesis"></a>
</p>
<p align="center">
<em>Mimesis: The Fake Data Generator</em>
</p>
<p align="center">
<a href="https://github.com/lk-geimfari/mimesis/actions/workflows/test.yml?query=branch%3Amaster" target="_blank">
<img src="https://github.com/lk-geimfari/mimesis/actions/workflows/test.yml/badge.svg?branch=master" alt="Test">
</a>
<a href="https://mimesis.name/en/latest/" target="_blank">
<img src="https://readthedocs.org/projects/mimesis/badge/?version=latest" alt="Coverage">
</a>
<a href="https://pypi.org/project/mimesis/" target="_blank">
<img src="https://img.shields.io/pypi/v/mimesis?color=bright-green" alt="Package version">
</a>
<a href="https://pypi.org/project/mimesis/" target="_blank">
<img src="https://img.shields.io/pypi/dm/mimesis" alt="Package version">
</a>
<a href="https://pypi.org/project/mimesis/" target="_blank">
<img src="https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%20pypy-brightgreen" alt="Supported Python versions">
</a>
</p>
---
**Documentation**: <a href="https://mimesis.name/" target="_blank">https://mimesis.name/</a>
---
Mimesis ([/mɪˈmiːsɪs](https://mimesis.name/en/latest/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.
The key features are:
- **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.
## Installation
To install mimesis, use pip:
```
~ 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.
## Documentation
You can find the complete documentation on the [Read the Docs](https://mimesis.name/).
It is divided into several sections:
- [About Mimesis](https://mimesis.name/en/latest/about.html)
- [Quickstart](https://mimesis.name/en/latest/quickstart.html)
- [Locales](https://mimesis.name/en/latest/locales.html)
- [Data Providers](https://mimesis.name/en/latest/providers.html)
- [Structured Data Generation](https://mimesis.name/en/latest/schema.html)
- [Random and Seed](https://mimesis.name/en/latest/random_and_seed.html)
- [Integration with Pytest](https://mimesis.name/en/latest/pytest_plugin.html)
- [Integration with factory_boy](https://mimesis.name/en/latest/factory_plugin.html)
- [API Reference](https://mimesis.name/en/latest/api.html)
- [Changelog](https://mimesis.name/en/latest/index.html#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:
```python
from mimesis import Person
from mimesis.locales import Locale
person = Person(Locale.EN)
person.full_name()
# Output: 'Brande Sears'
person.email(domains=['example.com'])
# Output: 'roccelline1878@example.com'
person.email(domains=['mimesis.name'], unique=True)
# Output: 'f272a05d39ec46fdac5be4ac7be45f3f@mimesis.name'
person.telephone(mask='1-4##-8##-5##3')
# Output: '1-436-896-5213'
```
## License
Mimesis is licensed under the MIT License. See [LICENSE](https://github.com/lk-geimfari/mimesis/blob/master/LICENSE) for more information.
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/5d/f1/33fb02aa19271a5a2334d24a597047399744a3f1e8c97be31053887260b4/mimesis-18.0.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://github.com/lk-geimfari/mimesis\"><img src=\"https://raw.githubusercontent.com/lk-geimfari/mimesis/master/.github/images/logo.png\" alt=\"Mimesis\"></a>\n</p>\n\n<p align=\"center\">\n <em>Mimesis: The Fake Data Generator</em>\n</p>\n\n<p align=\"center\">\n<a href=\"https://github.com/lk-geimfari/mimesis/actions/workflows/test.yml?query=branch%3Amaster\" target=\"_blank\">\n <img src=\"https://github.com/lk-geimfari/mimesis/actions/workflows/test.yml/badge.svg?branch=master\" alt=\"Test\">\n</a>\n<a href=\"https://mimesis.name/en/latest/\" target=\"_blank\">\n <img src=\"https://readthedocs.org/projects/mimesis/badge/?version=latest\" alt=\"Coverage\">\n</a>\n<a href=\"https://pypi.org/project/mimesis/\" target=\"_blank\">\n <img src=\"https://img.shields.io/pypi/v/mimesis?color=bright-green\" alt=\"Package version\">\n</a>\n<a href=\"https://pypi.org/project/mimesis/\" target=\"_blank\">\n <img src=\"https://img.shields.io/pypi/dm/mimesis\" alt=\"Package version\">\n</a>\n<a href=\"https://pypi.org/project/mimesis/\" target=\"_blank\">\n <img src=\"https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%20pypy-brightgreen\" alt=\"Supported Python versions\">\n</a>\n</p>\n\n---\n\n**Documentation**: <a href=\"https://mimesis.name/\" target=\"_blank\">https://mimesis.name/</a>\n\n---\n\nMimesis ([/m\u026a\u02c8mi\u02d0s\u026as](https://mimesis.name/en/latest/about.html#what-does-name-mean)) is a robust data generator for\nPython that can produce a wide range of fake data in various languages.\n\nThe key features are:\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\n## Installation\n\nTo install mimesis, use pip:\n\n```\n~ pip install mimesis\n```\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\n## Documentation\n\nYou can find the complete documentation on the [Read the Docs](https://mimesis.name/).\n\nIt is divided into several sections:\n\n- [About Mimesis](https://mimesis.name/en/latest/about.html)\n- [Quickstart](https://mimesis.name/en/latest/quickstart.html)\n- [Locales](https://mimesis.name/en/latest/locales.html)\n- [Data Providers](https://mimesis.name/en/latest/providers.html)\n- [Structured Data Generation](https://mimesis.name/en/latest/schema.html)\n- [Random and Seed](https://mimesis.name/en/latest/random_and_seed.html)\n- [Integration with Pytest](https://mimesis.name/en/latest/pytest_plugin.html)\n- [Integration with factory_boy](https://mimesis.name/en/latest/factory_plugin.html)\n- [API Reference](https://mimesis.name/en/latest/api.html)\n- [Changelog](https://mimesis.name/en/latest/index.html#changelog)\n\nYou can improve it by sending pull requests to this repository.\n\n## Usage\n\nThe library is exceptionally user-friendly, and it only requires you to import a **Data Provider** object that\ncorresponds 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,\nincluding name, surname, email, and other related fields:\n\n```python\nfrom mimesis import Person\nfrom mimesis.locales import Locale\n\nperson = Person(Locale.EN)\n\nperson.full_name()\n# Output: 'Brande Sears'\n\nperson.email(domains=['example.com'])\n# Output: 'roccelline1878@example.com'\n\nperson.email(domains=['mimesis.name'], unique=True)\n# Output: 'f272a05d39ec46fdac5be4ac7be45f3f@mimesis.name'\n\nperson.telephone(mask='1-4##-8##-5##3')\n# Output: '1-436-896-5213'\n```\n\n## License\n\nMimesis is licensed under the MIT License. See [LICENSE](https://github.com/lk-geimfari/mimesis/blob/master/LICENSE) for more information.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Mimesis: Fake Data Generator.",
"version": "18.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": "b6c80b91996ce5337bb877300d0a0e86df17ab72da573625348dcb6cd92c3c41",
"md5": "0cc4632f0b07e2d40f89cf667f89a818",
"sha256": "a51854a5ce63ebf2bd6a98e8841412e04cede38593be7e16d1d712848e6273df"
},
"downloads": -1,
"filename": "mimesis-18.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0cc4632f0b07e2d40f89cf667f89a818",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 4734674,
"upload_time": "2024-09-13T22:26:03",
"upload_time_iso_8601": "2024-09-13T22:26:03.283870Z",
"url": "https://files.pythonhosted.org/packages/b6/c8/0b91996ce5337bb877300d0a0e86df17ab72da573625348dcb6cd92c3c41/mimesis-18.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5df133fb02aa19271a5a2334d24a597047399744a3f1e8c97be31053887260b4",
"md5": "34545e262c85502ce5441f46bd67ff73",
"sha256": "7d7c76ecd680ae48afe8dc4413ef1ef1ee7ef20e16f9f9cb42892add642fc1b2"
},
"downloads": -1,
"filename": "mimesis-18.0.0.tar.gz",
"has_sig": false,
"md5_digest": "34545e262c85502ce5441f46bd67ff73",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 4681287,
"upload_time": "2024-09-13T22:26:05",
"upload_time_iso_8601": "2024-09-13T22:26:05.273481Z",
"url": "https://files.pythonhosted.org/packages/5d/f1/33fb02aa19271a5a2334d24a597047399744a3f1e8c97be31053887260b4/mimesis-18.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-13 22:26:05",
"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
