Introduction

This page should get you started with serqlane. The preferred method of development is using a nix shell, but it is not required.

Prerequisites

If you are using nix, it is the only prerequisite.

Activate your shell by running nix develop in the root of the repository.

Note

You may need to enable some experimental features if you have not done so already.
This can be done either by running nix develop --experimental-features 'nix-command flakes' or by adding the following to your nix config:

experimental-features = ["nix-command" "flakes"];

If you are not using nix, here is what you should have installed:

• Python 3.12+
• Poetry

Some optional quality of life packages:

• black
• isort
• vulture

Installation

After installing poetry you can run the following command to install all dependencies.

poetry install

Running

Serqlane Files

To run a serqlane file, run the following command:

poetry run serqlane <path-to-file>

Tests

To run the tests, run the following command:

poetry run pytest

Hello World

Create a file called hello.sq with the following contents:

dbg("Hello World!")

DBG: Hello World

Next Steps

Now that you have serqlane installed, you can check out Writing Serqlane to learn more about the language.