Create mocks for c-code automatically
Project description
Hammocking
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
- Documentation: https://hammocking.readthedocs.io
- PyPI: https://pypi.org/project/hammocking/
- Issues: https://github.com/avengineers/hammocking/issues
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hammocking-1.0.1.tar.gz.
File metadata
- Download URL: hammocking-1.0.1.tar.gz
- Upload date:
- Size: 406.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
81fb2b72da1402d81f15ccaaa818bc3c3464f5f68e8e0d8c75ffa6bbd0ffff65
|
|
| MD5 |
b624cfffa7072ec1799dace65c33c8bb
|
|
| BLAKE2b-256 |
ea26f20624a334890a43941bd537720288dbaf6fb8ef57056e9b65c2a04c8e10
|
File details
Details for the file hammocking-1.0.1-py3-none-any.whl.
File metadata
- Download URL: hammocking-1.0.1-py3-none-any.whl
- Upload date:
- Size: 12.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f2f13a20ac8dd1a02ffed8bb42261cac506d74f1758dd124b2678ffd2c814252
|
|
| MD5 |
59634716de5536faade446e7a4ad9f62
|
|
| BLAKE2b-256 |
22fb4601849b19fc9f57b060b2b1c16ea5d542aa45ac1192b5baee7567f15d85
|