{"id":19756626,"url":"https://github.com/esnet/cookiecutter-zeekpackage","last_synced_at":"2025-06-20T21:38:35.081Z","repository":{"id":49637596,"uuid":"282059675","full_name":"esnet/cookiecutter-zeekpackage","owner":"esnet","description":"Cookiecutter template for Zeek packages","archived":false,"fork":false,"pushed_at":"2021-06-11T16:58:41.000Z","size":139,"stargazers_count":5,"open_issues_count":7,"forks_count":0,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-04-30T11:55:49.622Z","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":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/esnet.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":"2020-07-23T21:32:41.000Z","updated_at":"2021-02-04T15:14:40.000Z","dependencies_parsed_at":"2022-09-16T12:41:33.805Z","dependency_job_id":null,"html_url":"https://github.com/esnet/cookiecutter-zeekpackage","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/esnet/cookiecutter-zeekpackage","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esnet%2Fcookiecutter-zeekpackage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esnet%2Fcookiecutter-zeekpackage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esnet%2Fcookiecutter-zeekpackage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esnet%2Fcookiecutter-zeekpackage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/esnet","download_url":"https://codeload.github.com/esnet/cookiecutter-zeekpackage/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esnet%2Fcookiecutter-zeekpackage/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261021456,"owners_count":23098354,"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-12T03:16:27.038Z","updated_at":"2025-06-20T21:38:30.051Z","avatar_url":"https://github.com/esnet.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cookiecutter Zeek Package\n\nCookiecutter template for a Zeek package (zkg).\n\n* GitHub repo: https://github.com/esnet/cookiecutter-zeekpackage\n* Free software: BSD license\n\n## Features\n\n* Script testing with ``btest``\n* GitHub integration: Actions for testing and building documentation as GitHub Pages\n* Documentation generation\n* Code coverage analysis\n\n## Quickstart\n\nInstall Cruft:\n\n    pip install -U cruft\n\n### New Package\n\nGenerate a Zeek package project:\n\n    cruft create https://github.com/esnet/cookiecutter-zeekpackage.git\n\nAnswer some questions, and it will create a new directory for you. Follow the instructions in README.md\n\n### Existing Package\n\nCreate a new branch (optional):\n\n    git checkout -b feat/use-template\n\nGo back up a directory, and run:\n\n    cd ..; cruft create -f https://github.com/esnet/cookiecutter-zeekpackage.git\n\nAnswer the questions. Note that `project_slug` must match your directory name.\n\nAt this point, some of your files have been overwritten. Run `git status`, and review the proposed changes. Some helpful commands:\n\n* To accept the changes, `git add filename`.\n* To reject the changes to an existing file, `git checkout -- filename`.\n* To reject the changes to a new file, `rm filename`.\n* If you want to save the old version of a file, to copy/paste some portions of it: `git show HEAD:README.rst \u003e README.old`\n\n## Updating\n\nTo update, `cruft update`.\n\nNote that in some cases, newly created files or files that were deleted may not get added correctly. There is a cruft issue tracking this behavior.\n\n## Configuration\n\nSome of the questions that that cookiecutter will prompt you for will likely be the same across many different packages. You can create a [cookiecutter configuration file](https://cookiecutter.readthedocs.io/en/1.7.2/advanced/user_config.html) as `~/.cookiecutterrc`, which will be read as the defaults:\n\n``` yaml\ndefault_context:\n    github_username: \"grigorescu\"\n    project_credits: \"Vlad Grigorescu \u003cvlad@es.net\u003e\"\n    project_namespace: \"ESnet\"\n    copyright_owner: \"Energy Sciences Network\"\n    open_source_license: \"BSD license\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fesnet%2Fcookiecutter-zeekpackage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fesnet%2Fcookiecutter-zeekpackage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fesnet%2Fcookiecutter-zeekpackage/lists"}