Getting Started with Opshin


This guide tries to assume as little knowledge as possible but there are certain assumptions:

  • You should understand Python. Opshin is basically Python so we assume some basic knowledge of Python.


Install Python 3.8, 3.9, 3.10 or 3.11. Then run:

python3 -m pip install opshin

Compiling Opshin Code

  1. Make a file called and copy:

    def validator(_: None) -> None:
        print("Hello world!")
  2. Run this command:

    $ opshin build

    This should create a build folder in the current directory. The build folder should look like this:


    We'll cover what all these files in the hello_world sub-folder mean later in the book.