{"id":20208429,"url":"https://github.com/scarvy/mockaroo-python","last_synced_at":"2026-02-25T09:38:02.994Z","repository":{"id":199763933,"uuid":"700588588","full_name":"Scarvy/mockaroo-python","owner":"Scarvy","description":"A Python wrapper for the Mockaroo API 🦘 + 🐍.","archived":false,"fork":false,"pushed_at":"2024-04-17T22:05:15.000Z","size":100,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-24T11:44:52.060Z","etag":null,"topics":["api","mock-data","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Scarvy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-04T22:09:54.000Z","updated_at":"2024-04-17T05:16:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"698d1fa6-78a0-4753-b901-67d2c169f5e5","html_url":"https://github.com/Scarvy/mockaroo-python","commit_stats":null,"previous_names":["scarvy/mockaroo-python"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scarvy%2Fmockaroo-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scarvy%2Fmockaroo-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scarvy%2Fmockaroo-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scarvy%2Fmockaroo-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Scarvy","download_url":"https://codeload.github.com/Scarvy/mockaroo-python/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248222406,"owners_count":21067776,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","mock-data","python"],"created_at":"2024-11-14T05:35:33.572Z","updated_at":"2026-02-25T09:38:02.988Z","avatar_url":"https://github.com/Scarvy.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mockaroo-python\n\n[![PyPI](https://img.shields.io/pypi/v/mockaroo-python.svg)](https://pypi.org/project/mockaroo-python/)\n[![Changelog](https://img.shields.io/github/v/release/Scarvy/mockaroo-python?include_prereleases\u0026label=changelog)](https://github.com/Scarvy/mockaroo-python/releases)\n\nA Python wrapper for the Mockaroo API 🦘 + 🐍.\n\n## Installation\n\nInstall this tool using `uv`:\n\n    uv add mockaroo-python\n\n## Prerequisites\n\nTo use this library, you'll need an API key from the [Mockaroo website](https://www.mockaroo.com/docs#Gaining_Access).\n\nSet your key as an environment variable:\n\n```bash\nexport MOCKAROO_API_KEY=\u003capi_key\u003e\n```\n\nor pass it to the `Client` class as an argument:\n\n```python\nclient = Client(api_key=\"api_key\")\n```\n\n## Usage\n\nUse the library in your Python script or from the command-line.\n\n**Command-Line**:\n\nFor help, run:\n\n```bash\nmockaroo --help\n```\n\nYou can also use:\n\n```bash\npython -m mockaroo --help\n```\n\nGenerate a dataset:\n\n```bash\nmockaroo gen Person # your own schema in Mockaroo\n\n[\n    {\n        \"id\": 1,\n        \"first_name\": \"Burch\",\n        \"last_name\": \"Minichi\"\n    },\n    {\n        \"id\": 2,\n        \"first_name\": \"Val\",\n        \"last_name\": \"Curzon\"\n    },\n    {\n        \"id\": 3,\n        \"first_name\": \"Poppy\",\n        \"last_name\": \"Pallant\"\n    }\n]\n```\n\nWrite data to a file format (JSON, CSV, TXT, XML, or SQL):\n\n```bash\nmockaroo gen Person --count 5 \u003e\u003e people.json\n```\n\nUpload a file to Mockaroo:\n\n```bash\nmockaroo upload customers customers.csv\n```\n\nDelete a file:\n\n```bash\nmockaroo delete customers\n```\n\nCheck the available Mockaroo types:\n\n```bash\nmockaroo types\n```\n\n**Python Script**:\n\n```python\nfrom mockaroo import Client\n\n# Initialize the client with your API key\nclient = Client(api_key=\"your_api_key_here\")\n# Or set an enviornment variable. `export API_KEY=your_api_key_here`\nclient = Client()\n\n# Fetch available types from Mockaroo\ntypes = client.types()\n\n# Upload a dataset ('csv' or 'txt') to Mockaroo\nclient.upload(name=\"name_of_dataset\", path=\"/path/to/file.csv\")\n\n# Remove a dataset from Mockaroo\nclient.delete(name=\"name_of_dataset\")\n\n# Generate data using a predefined schema\ndata = client.generate(schema=\"name_of_schema\")\n\n# Alternatively, specify fields to generate custom data\ndata = client.generate(\n    fields=[\n        {\"name\": \"city\", \"type\": \"City\"},\n        {\"name\": \"street_name\", \"type\": \"Street Name\"}\n    ]\n)\n```\n\n## Ways to Generate Mockaroo Datasets\n\n### Using Predefined Schemas\n\nTo generate data based on a schema you've created, specify the schema name as an argument.\n\n**Example:**\n\n```python\nfrom mockaroo import Client\n\nclient = Client()\n\ndata = client.generate(schema=\"Person\")\n\nprint(data)\n{'id': 1, 'first_name': 'Patrizius', 'last_name': 'Van'}\n```\n\n### Using Custom Fields\n\nPass a list of field definitions to generate mock data with custom fields. For a full list of available types, see the [Official API Reference Page](https://www.mockaroo.com/docs#Types).\n\n**Example**:\n\n```python\nresult = client.generate(\n    count=2, \n    fields=[\n        {\n            \"name\": \"id\", \n            \"type\": \"Row Number\"\n        }, \n        {\n            \"name\":\"transactionType\",\n            \"type\": \"Custom List\", \n            \"values\": [\"credit\",\"debit\"]\n        }\n    ]\n)\nprint(result)\n[{'id': 1, 'transactionType': 'credit'}, {'id': 2, 'transactionType': 'debit'}]\n```\n\n## Development\n\nTo contribute to this tool, first checkout the code. Then create a new virtual environment:\n\n    cd mockaroo-python\n    uv sync --dev\n\nTo run the tests:\n\n    uv run pytest\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscarvy%2Fmockaroo-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscarvy%2Fmockaroo-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscarvy%2Fmockaroo-python/lists"}