Skip to main content

Create mocks for c-code automatically

Project description

Hammocking

CI Status Documentation Status Test coverage percentage

uv ruff pre-commit

PyPI Version Supported Python versions License

Automatic mocking tool for C.

Installation

Install from PyPI:

pip install hammocking

Or with uv:

uv add hammocking

Hammocking depends on Jinja2 and libclang. They are installed automatically.

Development

DevPod / Dev Container (recommended)

The fastest way to get a working development environment is DevPod or any devcontainer-compatible tool (VS Code Dev Containers, GitHub Codespaces).

# Using DevPod CLI
devpod up https://github.com/avengineers/hammocking

# Or in VS Code: clone the repo, open it, and select "Reopen in Container"

The container comes with Python 3.13, uv, clang, llvm, cmake, and ninja-build.

Linux / macOS

Prerequisites

  • Python 3.10 or higher (3.13 recommended)
  • Git

Optional, for integration tests:

  • clang / llvm
  • cmake
  • ninja-build

On Ubuntu/Debian:

sudo apt update
sudo apt install python3.13 python3.13-venv python3-pip git

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

Build

./build.sh              # full build (lint, test, docs)
./build.sh --clean      # clean build
./build.sh --install    # install dependencies only

Windows

Build

.\build.ps1             # full build (lint, test, docs)
.\build.ps1 -clean      # clean build
.\build.ps1 -install    # install dependencies only

Setting up the development environment manually

uv sync
uv run pre-commit install

Running tests

uv run pytest               # all tests
uv run pytest -m unit        # unit tests only
uv run pytest -m integration # integration tests only

If integration tests fail because clang is not installed, skip them:

uv run pytest -m "not integration"

What the build does

  • Pre-commit checks and linting
  • Running all tests
  • Building documentation

Troubleshooting

uv not found

Make sure ~/.local/bin is on your PATH:

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

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

Lock file errors

uv lock
uv sync

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hammocking-1.0.2.tar.gz (406.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hammocking-1.0.2-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file hammocking-1.0.2.tar.gz.

File metadata

  • Download URL: hammocking-1.0.2.tar.gz
  • Upload date:
  • Size: 406.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for hammocking-1.0.2.tar.gz
Algorithm Hash digest
SHA256 309a3fff0a1c4461390128c82abe7881599f018ba6be828b1cbc51860fe60f47
MD5 5101fbfec35001d402601b3c1ae9aa6b
BLAKE2b-256 fd0eb0c0ee876af8ad404c3c1e277d24da9bc9c82e747a93ea31283afe8a5825

See more details on using hashes here.

File details

Details for the file hammocking-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: hammocking-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for hammocking-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7fa0124b268b8941794a83427a0aa9d3001c75a9f3b458ab03316d07febec7a9
MD5 b02c6f6852d3120606cdda1c2de632d7
BLAKE2b-256 968670140c041f2e4210054e81bf26afca6dffe4527f8a7d915aa5da1769bf62

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page