{"id":19498057,"url":"https://github.com/patrickalphac/vheader","last_synced_at":"2025-06-22T12:08:38.245Z","repository":{"id":257009079,"uuid":"857112697","full_name":"PatrickAlphaC/vheader","owner":"PatrickAlphaC","description":"A tool for making perfect vyper headers, inspired by transmissions11","archived":false,"fork":false,"pushed_at":"2024-09-13T23:07:01.000Z","size":18,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-05T06:53:44.226Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PatrickAlphaC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-09-13T20:36:19.000Z","updated_at":"2025-03-28T15:26:45.000Z","dependencies_parsed_at":"2024-09-14T09:52:50.654Z","dependency_job_id":"83d58fdc-f60a-4e9d-8cd7-077c20b12873","html_url":"https://github.com/PatrickAlphaC/vheader","commit_stats":null,"previous_names":["patrickalphac/vheader"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/PatrickAlphaC/vheader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PatrickAlphaC%2Fvheader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PatrickAlphaC%2Fvheader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PatrickAlphaC%2Fvheader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PatrickAlphaC%2Fvheader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PatrickAlphaC","download_url":"https://codeload.github.com/PatrickAlphaC/vheader/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PatrickAlphaC%2Fvheader/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261289418,"owners_count":23136070,"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-10T21:49:05.901Z","updated_at":"2025-06-22T12:08:33.181Z","avatar_url":"https://github.com/PatrickAlphaC.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vheader\n\n\u003e [!Important]\n\u003e I found out after that [Transmissions11 also made one for Vyper.](https://github.com/transmissions11/headers-vy)\n\nGenerate perfect Vyper code headers every time.\n\nForked from [transmissions11/headers](https://github.com/transmissions11/headers/tree/master)\n\n\u003e [!Note]\n\u003e [There is also a version of this built in python (to be installed with `pip`)](https://pypi.org/project/vheader/)\n\n## Build\n\nYou need Rust and Cargo installed on your machine. See the installation guide\n[here](https://doc.rust-lang.org/cargo/getting-started/installation.html).\n\nThen clone the repo and install the CLI globally like this:\n\n```sh\ncargo install --path .\n```\n\n## Usage\n\n```sh\nvheader \"external functions\"\n```\n\n```python\n# ------------------------------------------------------------------\n#                       EXTERNAL FUNCTIONS\n# ------------------------------------------------------------------\n```\n\nIt will also copy the header to your clipboard automatically.\n\n### With VSCode\n\nSet your global [`tasks.json`](https://stackoverflow.com/questions/41046494/making-global-tasks-in-vs-code) like so to add the command as task:\n\n```json\n{\n  \"version\": \"2.0.0\",\n  \"tasks\": [\n    {\n      \"label\": \"Generate Header\",\n      \"type\": \"shell\",\n      \"command\": \"vheader ${input:header}\",\n      \"presentation\": {\n        \"reveal\": \"never\"\n      },\n      \"problemMatcher\": []\n    }\n  ],\n  \"inputs\": [\n    {\n      \"id\": \"header\",\n      \"description\": \"Header\",\n      \"type\": \"promptString\"\n    }\n  ]\n}\n```\n\nTo really speed-up your workflow, you can even add a keybind for the task in [`keybindings.json`](https://code.visualstudio.com/docs/getstarted/keybindings):\n\n```json\n[\n  {\n    \"key\": \"CMD+h\",\n    \"command\": \"workbench.action.tasks.runTask\",\n    \"args\": \"Generate Header\"\n  }\n]\n```\n\nThis will copy the generated header to your clipboard.\n\n## Credits\n\n- Inspired by virtualjpeg's [`blocky`](https://github.com/virtualjpeg/blocky).\n- Forked from [transmissions11 headers](https://github.com/transmissions11/headers)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrickalphac%2Fvheader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpatrickalphac%2Fvheader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrickalphac%2Fvheader/lists"}