{"id":19498063,"url":"https://github.com/patrickalphac/vheader-py","last_synced_at":"2026-01-31T13:35:00.557Z","repository":{"id":257032809,"uuid":"857128900","full_name":"PatrickAlphaC/vheader-py","owner":"PatrickAlphaC","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-13T23:14:12.000Z","size":4,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-20T14:43:03.243Z","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/PatrickAlphaC.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-13T21:32:57.000Z","updated_at":"2024-09-14T15:35:57.000Z","dependencies_parsed_at":"2024-09-14T13:05:42.742Z","dependency_job_id":"dc78de0e-21b6-478b-98ee-1e33fc82045d","html_url":"https://github.com/PatrickAlphaC/vheader-py","commit_stats":null,"previous_names":["patrickalphac/vheader-py"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/PatrickAlphaC/vheader-py","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PatrickAlphaC%2Fvheader-py","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PatrickAlphaC%2Fvheader-py/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PatrickAlphaC%2Fvheader-py/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PatrickAlphaC%2Fvheader-py/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PatrickAlphaC","download_url":"https://codeload.github.com/PatrickAlphaC/vheader-py/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PatrickAlphaC%2Fvheader-py/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28944783,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T13:02:32.153Z","status":"ssl_error","status_checked_at":"2026-01-31T13:00:07.528Z","response_time":128,"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":[],"created_at":"2024-11-10T21:49:06.230Z","updated_at":"2026-01-31T13:35:00.541Z","avatar_url":"https://github.com/PatrickAlphaC.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vheader\n\nGenerate perfect Vyper code headers every time, pythonically.\n\n\u003e [!NOTE]  \n\u003e [There is also a version of this in rust.](https://github.com/PatrickAlphaC/vheader)\n\n\n# Getting Started \n\n## Prerequisites\n\nYou need to be able to install python packages, with either:\n- [pip](https://pypi.org/project/pip/)\n- [uv](https://docs.astral.sh/)\n- [pipx](https://github.com/pypa/pipx)\n\nOr whatever you prefer to install python packages. We recommend using `uv`. You can head over to their docs, or try to run:\n\n```bash\ncurl -LsSf https://astral.sh/uv/install.sh | sh\n```\n\nTo install. \n\n## Installation\n\nWe prefer to install this into an insolated virtual environment with `uv`. You can do that as so:\n\n```bash\nuv tool install vheader\n```\n\nBut you can also install any other way you please:\n\n```bash\npip install vheader\npipx install vheader\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 [transmissions11 headers](https://github.com/transmissions11/headers)\n  - Who was inspired by virtualjpeg's [`blocky`](https://github.com/virtualjpeg/blocky).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrickalphac%2Fvheader-py","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpatrickalphac%2Fvheader-py","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrickalphac%2Fvheader-py/lists"}