Skip to content
PineXQ Logo PineXQ Documentation

Hello World

Project initialization

Section titled “Project initialization”

Once you have installed uv, create an empty project folder, then run the following command inside:

Terminal window
uvx --from pinexq-cli@latest pinexq init

This will run the pinexq CLI from the latest version of the package pinexq-cli, without installing it. After asking you a few questions, the CLI will create some template project files, including a main.py file implementing a simple Step. You can then edit and customize these files as needed.

If you wish to instead install the pinexq client with either uv or pipx, run the following:

Terminal window
uv tool install pinexq-cli

You can then initialize your project with

Terminal window
pinexq init

Note that our CLI is currently under active development; if you choose to install pinexq, you may need to update it regularly:

Terminal window
uv tool upgrade pinexq-cli

Hello World

Section titled “Hello World”

ProcessingSteps are designed to be deployed on a cloud system like pinexq.net. However, they can also be tested and run locally. Your project’s main.py implements the step function hello_world(). To run it locally, use the following command:

Terminal window
foo@bar: ~/my_project$ uv run main.py run -f hello_world
23-01-26 16:00:35 INFO Platform and package information:
OS: Linux-6.6.87.1-microsoft-standard-WSL2-x86_64-with-glibc2.39
Python: CPython 3.14.0
pinexq-procon: 2.3.0
pinexq-client: 1.0.0
23-01-26 16:00:35 INFO Hello World!
Hello World!

Note that if this is the first time you have run your step, uv will analyze your project’s pyproject.toml, determine a resolution for all supported Python versions, then install the packages for your pinned Python version to a .venv in your project directory. Future uv run calls will then use this .venv, updating it as needed.

Next Steps

Section titled “Next Steps”

Congratulations! You have taken your first step towards implementing a ProcessingStep. You are now ready to begin implementing your own steps.