{"id":20513471,"url":"https://github.com/defectdojo/cookiecutter-scanner-parser","last_synced_at":"2025-04-13T23:53:55.983Z","repository":{"id":50131402,"uuid":"351882930","full_name":"DefectDojo/cookiecutter-scanner-parser","owner":"DefectDojo","description":"A scanner parser template generator for DefectDojo","archived":false,"fork":false,"pushed_at":"2023-01-10T21:09:23.000Z","size":50,"stargazers_count":6,"open_issues_count":0,"forks_count":5,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-04-12T07:29:25.937Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/DefectDojo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-03-26T18:52:54.000Z","updated_at":"2023-06-29T11:25:38.000Z","dependencies_parsed_at":"2023-02-08T20:15:44.665Z","dependency_job_id":null,"html_url":"https://github.com/DefectDojo/cookiecutter-scanner-parser","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DefectDojo%2Fcookiecutter-scanner-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DefectDojo%2Fcookiecutter-scanner-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DefectDojo%2Fcookiecutter-scanner-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DefectDojo%2Fcookiecutter-scanner-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DefectDojo","download_url":"https://codeload.github.com/DefectDojo/cookiecutter-scanner-parser/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248799911,"owners_count":21163403,"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":[],"created_at":"2024-11-15T21:11:16.292Z","updated_at":"2025-04-13T23:53:55.964Z","avatar_url":"https://github.com/DefectDojo.png","language":"Python","readme":"A [cookiecutter](https://github.com/cookiecutter/cookiecutter) template for generating\na new [DefectDojo](https://www.defectdojo.org/) scanner parser.\n\n## Features\n\n- Generates the appropriate file structure and parser for a minimal scanner parser.\n- Contains everything needed to get started with writing unit tests for your scanner parser.\n\n## Installation\n\nTo get started you will need to install [cookiecutter](https://github.com/cookiecutter/cookiecutter).\n\n```bash\n$ pip install cookiecutter\n```\n\nThen generate your scanner parser from the root of django-DefectDojo:\n\n```bash\n$ cookiecutter https://github.com/DefectDojo/cookiecutter-scanner-parser\n```\n\n## Context Options\n\nYou will be asked to provide the following values to configure your scanner parser:\n\n| Field               | Default                               | Description                                                                                                                                                                                  |\n| ------------------- | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n|                                                                                                                                                                                                                                                            |\n| tool name           | My Scanner                            | The human readable name of your scanner.                                                                                                                                                     |\n| tool_directory_name | Lowercase name of my scanner          | The directory name of the scanner (in most cases choose the default).                                                                                                                        |\n| tool_class_name     | Capitalized name of scanner           | Class name of scanner in the parser.py file. (in most cases choose the default).                                                                                                             |\n| tool_description    | My scanner is for ....                | Brief Description of scanner                                                                                                                                                                 |\n| tool_type           | None                                  | Select the kind of scanner, static or dynamic.                                                                                                                                               |\n| tool_file_type      | None                                  | Scanner import file type: CSV, JSON or XML.                                                                                                                                                  |\n\n## On completion\n\nThe directory, parser and scanner will be copied to the appropriate folder locations.\n\nSample Output:\n\n```bash\n######################################\nFile templates created for Fossa\n######################################\n../temp-fossa/tools/fossa/__init__.py\n../temp-fossa/tools/fossa/parser.py\n../temp-fossa/unittests/tools/test_fossa_parser.py\n../temp-fossa/unittests/scans/fossa/empty_with_error.json\n../temp-fossa/unittests/scans/fossa/fossa_many_vul.json\n../temp-fossa/unittests/scans/fossa/fossa_zero_vul.json\n../temp-fossa/unittests/scans/fossa/fossa_one_vul.json\n######################################\nFiles moved to:\n######################################\n/django-DefectDojo/dojo/tools\n/django-DefectDojo/dojo/unittests/scans\n/django-DefectDojo/dojo/unittests/tools/test_fossa_parser.py\nModified: dojo/fixtures/test_type.json\nAdded:\n{\n    \"fields\": {\n        \"name\": \"Fossa\"\n    },\n    \"model\": \"dojo.test_type\",\n    \"pk\": 232\n}\nRemoving temp directory\n######################################\nComplete, go forth and make it so!\n######################################\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdefectdojo%2Fcookiecutter-scanner-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdefectdojo%2Fcookiecutter-scanner-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdefectdojo%2Fcookiecutter-scanner-parser/lists"}