Home

Awesome

vheader

Generate perfect Vyper code headers every time, pythonically.

[!NOTE]
There is also a version of this in rust.

Getting Started

Prerequisites

You need to be able to install python packages, with either:

Or whatever you prefer to install python packages. We recommend using uv. You can head over to their docs, or try to run:

curl -LsSf https://astral.sh/uv/install.sh | sh

To install.

Installation

We prefer to install this into an insolated virtual environment with uv. You can do that as so:

uv tool install vheader

But you can also install any other way you please:

pip install vheader
pipx install vheader

Usage

vheader "external functions"

# ------------------------------------------------------------------
#                       EXTERNAL FUNCTIONS
# ------------------------------------------------------------------

It will also copy the header to your clipboard automatically.

With VSCode

Set your global tasks.json like so to add the command as task:

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Generate Header",
      "type": "shell",
      "command": "vheader ${input:header}",
      "presentation": {
        "reveal": "never"
      },
      "problemMatcher": []
    }
  ],
  "inputs": [
    {
      "id": "header",
      "description": "Header",
      "type": "promptString"
    }
  ]
}

To really speed-up your workflow, you can even add a keybind for the task in keybindings.json:

[
  {
    "key": "CMD+h",
    "command": "workbench.action.tasks.runTask",
    "args": "Generate Header"
  }
]

This will copy the generated header to your clipboard.

Credits