{"id":41447936,"url":"https://github.com/openraven/mockingbird","last_synced_at":"2026-01-23T15:09:19.079Z","repository":{"id":52069233,"uuid":"332089414","full_name":"openraven/mockingbird","owner":"openraven","description":"A toolset to test data classification engines that generates mock data in various file formats, sizes and data profiles. ","archived":false,"fork":false,"pushed_at":"2024-01-12T20:36:14.000Z","size":578,"stargazers_count":44,"open_issues_count":3,"forks_count":6,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-09-25T04:56:18.399Z","etag":null,"topics":["data-classification","synthetic-data-generation"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openraven.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-01-22T23:49:59.000Z","updated_at":"2025-09-25T03:26:32.000Z","dependencies_parsed_at":"2024-01-12T20:36:56.057Z","dependency_job_id":"9dcb4689-e334-4bd9-82c6-36fcc431771b","html_url":"https://github.com/openraven/mockingbird","commit_stats":{"total_commits":7,"total_committers":2,"mean_commits":3.5,"dds":0.4285714285714286,"last_synced_commit":"161a2400c2d42d9b568850ac283a874d66c08c03"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/openraven/mockingbird","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openraven%2Fmockingbird","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openraven%2Fmockingbird/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openraven%2Fmockingbird/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openraven%2Fmockingbird/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openraven","download_url":"https://codeload.github.com/openraven/mockingbird/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openraven%2Fmockingbird/sbom","scorecard":{"id":709971,"data":{"date":"2025-08-11","repo":{"name":"github.com/openraven/mockingbird","commit":"0717aba8f5b6dc0fa3cc8f68ab729db7cf7f09c4"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.3,"checks":[{"name":"Code-Review","score":1,"reason":"Found 1/10 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Security-Policy","score":9,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Info: Found linked content: SECURITY.md:1","Warn: One or no descriptive hints of disclosure, vulnerability, and/or timelines in security policy","Info: Found text in security policy: SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact 1.1.2 not signed: https://api.github.com/repos/openraven/mockingbird/releases/136894955","Warn: release artifact 1.1.2 does not have provenance: https://api.github.com/repos/openraven/mockingbird/releases/136894955"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 10 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"12 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2023-188","Warn: Project is vulnerable to: GHSA-6p56-wp2h-9hxr","Warn: Project is vulnerable to: GHSA-fpfv-jqm9-f5jm","Warn: Project is vulnerable to: PYSEC-2024-161","Warn: Project is vulnerable to: PYSEC-2023-44 / GHSA-329j-jfvr-rhr6","Warn: Project is vulnerable to: GHSA-9q9m-c65c-37pq","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2023-74 / GHSA-j8r2-6x86-q33q","Warn: Project is vulnerable to: PYSEC-2025-49 / GHSA-5rjg-fvgr-3xxf","Warn: Project is vulnerable to: GHSA-cx63-2mw6-8hw5","Warn: Project is vulnerable to: PYSEC-2022-43012 / GHSA-r9hx-vwmv-q579"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-22T07:50:35.443Z","repository_id":52069233,"created_at":"2025-08-22T07:50:35.443Z","updated_at":"2025-08-22T07:50:35.443Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28694466,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T14:15:13.573Z","status":"ssl_error","status_checked_at":"2026-01-23T14:09:05.534Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["data-classification","synthetic-data-generation"],"created_at":"2026-01-23T15:09:18.222Z","updated_at":"2026-01-23T15:09:19.074Z","avatar_url":"https://github.com/openraven.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mockingbird: Generate mock documents for data classification\n\n## About\n\nMockingbird is a Python library for generating mock documents in various formats. It accepts user-defined data, and embeds it into documents generated in many different formats. Developers can use Mockingbird to quickly generate datasets, with particular use for validating the efficacy of a data classification software. \n\n## Installation\n \nThe easiest way to install Mockingbird is by using `pip`:\n\n`pip install mockingbird`\n\nFor local development, clone the repository and run `pip install .`\n\n## Getting Started\n\nMockingbird can run as a functional Python library or as a CLI. \n\n\n### CLI Usage\n\nOnce installed with pip, unix-like systems can use the command `mockingbird_cli --h` to access Mockingbird's \ncommand line interface. Some sample CLI calls are:\n\n```\nmockingbird_cli --type dry -o ./output/dry_test/\nmockingbird_cli --type csv -i ./samples/csv_sample.csv -o ./output/csv/\nmockingbird_cli --type csv_curl -i \u003ccurl'able URL\u003e -o ./output/csv_curl/\nmockingbird_cli --type mockaroo -i ./samples/sample_schema.json --mockaroo_api \u003cmockaroo API\u003e -o ./output/mockaroo\n```\n\n### As a Python Library\n\n#### Starting from Code\n\nMockingbird functions as a fully functional Python library. A basic example generating documents using\nmock-data is demonstrated below. In this example, key-value pairs are inserted as strings mapping to a list of strings. \n\n\n```\nfrom mockingbird import Mockingbird\n\n# Spawn a new Mockingbird session\nfab = Mockingbird()\n\n# Set which file extensions to output\nfab.set_file_extensions([\"html\", \"docx\", \"yaml\", \"xlsx\", \"odt\"])\n\n# Input the data we want to test / inject into the documents\nfab.add_sensitive_data(keyword=\"ssn\", entries=[\"000-000-0000\", \"999-999-9999\"])\nfab.add_sensitive_data(keyword=\"dob\", entries=[\"01/01/1991\", \"02/02/1992\"])\n\n# Generate and save the fabricated documents\nfab.save(save_path=\"./output_basic/\")\nfab.dump_meta_data(output_file=\"./output_basic/meta_data.json\")\n```\n\n\n#### Starting from CSV\n\nMockingbird can be started using a CSV file, treating the column headers as keywords, and the remaining rows as entries. \n\nThe CSV's are expected to be structured as the following,\n```\nFILE: mockingbird_data.csv\n\nssn, dob\n000-000-000, 01/01/1991\n999-999-999, 02/02/1992\n```\n\n```\nfrom mockingbird.mb_wrappers import MockingbirdFromCSV\n\n\n# This effectively loads files from the csv and generates a session using each column\nfab = MockingbirdFromCSV(\"csv_sample.csv\")\nfab.set_all_extensions()\n\nfab.save(save_path=\"./output_csv/\")\nfab.dump_meta_data(output_file=\"./output_csv/meta_data.json\")\n```\n\nOptionally, multiple keywords can be defined in the CSV header file, which Mockingbird will split up into separate \nkeywords. For example, rather than just testing the keyword ```ssn```, we can test ```ssn``` and ```social security number```.\nMultiple keywords can be defined in the CSV file by using `;` as a delimiter. \n\nFor example,\n\n```\nFILE: mockingbird_data.csv\n\nssn;social security number,dob;date of birth;birth\n000-000-000, 01/01/1991\n999-999-999, 02/02/1992\n```\n\nThis will generate documents for each keyword in each column header. \n\n\n#### Starting Using Mockaroo\n\nUsing a Mockaroo API key, we can request mocked data using json requests from Mockaroo's servers. Currently, the request has to be saved to\na json file on disk, and loaded during runtime. More documentation can be found at [Mockaroo's Website](https://www.mockaroo.com/api/docs), but below\nis a json-example.\n\n```\nFILE: mockaroo_request.json\n\n[\n  {\n    \"name\": \"ssn;social security;social\",\n    \"type\": \"SSN\"\n  },\n  {\n    \"name\": \"cc;credit card\",\n    \"type\": \"Credit Card #\"\n  },\n  {\n    \"name\": \"phone;phone-number;number\",\n    \"type\": \"Phone\"\n  },\n  {\n    \"name\": \"name;fullname;full name\",\n    \"type\": \"Full Name\"\n  }\n]\n```\n\nIn code, Mockingbird can use this request as a json-payload, \n\n```\nimport json\nfrom mockingbird.mb_wrappers import MockingbirdFromMockaroo\n\nwith open(\"mockaroo_request.json\") as json_file:\n    schema_request = json.load(json_file)\n\nfab = MockingbirdFromMockaroo(api_key=\"MOCKAROO_API_KEY\", schema_request=schema_request)\nfab.set_all_extensions()\nfab.save(save_path=\"./output_mockaroo/\")\nfab.dump_meta_data(output_file=\"./output_mockaroo/meta_data.json\")\n```\n\n\n## License\n\nLicensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full license text.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenraven%2Fmockingbird","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenraven%2Fmockingbird","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenraven%2Fmockingbird/lists"}