Skip to content

LINUX_QUICKSTART.md

Latest commit

 

History

History
109 lines (78 loc) · 2.15 KB

LINUX_QUICKSTART.md

File metadata and controls

109 lines (78 loc) · 2.15 KB

Linux Quickstart Guide

This guide helps you get started with hammocking on Linux.

Prerequisites

Required

  • Python 3.10 or higher (3.13 recommended)
  • Git

Optional (for integration tests)

  • clang/llvm
  • ninja-build

Installing Prerequisites on Ubuntu/Debian

# Install Python 3.13
sudo apt update
sudo apt install python3.13 python3.13-venv python3-pip

# Optional: Install build tools for integration tests
sudo apt install clang ninja-build llvm

Installation

Using the build script

# Clone the repository
git clone https://github.com/avengineers/hammocking
cd hammocking

# Install dependencies
./build.sh --install

# Run full build (includes lint, test, docs)
./build.sh

Common Tasks

The common tasks are separated as functions within ./build.sh.

Setup Development Environment

# Complete setup with pre-commit hooks
./build.sh --setup

# Or manually
poetry install
poetry run pre-commit install

build.sh Targets Reference

Run ./build.sh --help to see all available targets.

Troubleshooting

Poetry Not Found

If poetry command is not found after installation:

export PATH="$HOME/.local/bin:$PATH"

Add this to your ~/.bashrc or ~/.zshrc to make it permanent.

Python Version Issues

Check your Python version:

python3 --version

If you need to use a specific Python version with poetry:

poetry env use python3.13

Integration Test Failures

If integration tests fail due to missing clang:

# Skip integration tests
poetry run pytest -v -m "not integration"

# Or install clang
sudo apt install clang

Lock File Issues

If you see "poetry.lock changed" errors:

poetry lock
poetry install

Getting Help

Next Steps

  1. Read the full documentation: ./build.sh && firefox out/docs/html/index.html
  2. Explore the examples in docs/usage/examples/
  3. Check out the test files in tests/ to see how to use the API