Build system generator - Makefile, CMake, and more.
Project description
buildgen
A build system generator package supporting Makefile, CMake, and cross-generator project definitions.
Originally inspired by prior work on shedskin.makefile in the shedskin project.
Installation
pip install buildgen
Quick Start
# Create a C++ project
buildgen project init -n myapp --recipe cpp/executable
# Create a Python extension with pybind11
buildgen project init -n myext --recipe py/pybind11
# List available recipes
buildgen project recipes
Features
- Makefile Generation: Programmatic Makefile creation with variables, pattern rules, conditionals
- CMake Generation: Full CMakeLists.txt generation with find_package, FetchContent, install rules
- Cross-Generator: Define project once in JSON/YAML, generate both build systems
- CMake Frontend: Use CMake as build system with convenient Makefile frontend
- Project Templates: Quick-start templates for common project types
- scikit-build-core Templates: Python extension project scaffolding (pybind11, cython, nanobind, C)
- Template Customization: Override templates per-project, per-user, or via environment variable (Mako syntax)
Usage
CLI
# Create projects from recipes
buildgen project init -n myapp --recipe cpp/executable
buildgen project init -n mylib --recipe c/static
buildgen project init -n myext --recipe py/pybind11
# Short form
buildgen project init -n myapp -r cpp/full
# List available recipes
buildgen project recipes
# Direct Makefile generation
buildgen makefile generate -o Makefile --targets "all:main.o:"
# Direct CMake generation
buildgen cmake generate -o CMakeLists.txt --project myapp --cxx-standard 17
Python API
from buildgen import ProjectConfig, TargetConfig, DependencyConfig
# Load from config file
config = ProjectConfig.load("project.json")
config.generate_all() # Creates Makefile and CMakeLists.txt
# Or build programmatically
config = ProjectConfig(
name="myproject",
version="1.0.0",
cxx_standard=17,
compile_options=["-Wall", "-Wextra"],
dependencies=[
DependencyConfig(name="Threads"),
DependencyConfig(
name="fmt",
git_repository="https://github.com/fmtlib/fmt.git",
git_tag="10.1.1",
),
],
targets=[
TargetConfig(
name="mylib",
target_type="static",
sources=["src/lib.cpp"],
include_dirs=["include"],
),
TargetConfig(
name="myapp",
target_type="executable",
sources=["src/main.cpp"],
link_libraries=["mylib", "fmt::fmt"],
install=True,
),
],
)
config.generate_all()
CMake with Makefile Frontend
Generate CMake as the build system with a Makefile that wraps cmake commands:
config.generate_cmake_with_frontend(
build_dir="build",
build_type="Release",
)
This creates:
CMakeLists.txt- The actual build logicMakefile- Convenience wrapper with targets:
make # Configure and build
make build # Same as above
make configure # Run cmake configure only
make clean # Remove build directory
make rebuild # Clean and rebuild
make install # Install the project
make test # Run tests with ctest
make myapp # Build specific target
make help # Show available targets
# Override defaults
make BUILD_TYPE=Debug
make BUILD_DIR=cmake-build
make CMAKE_FLAGS="-DFOO=bar"
Project Configuration
JSON Format
{
"name": "myproject",
"version": "1.0.0",
"cxx_standard": 17,
"compile_options": ["-Wall", "-Wextra"],
"dependencies": [
"Threads",
{"name": "OpenSSL", "required": true},
{
"name": "fmt",
"git_repository": "https://github.com/fmtlib/fmt.git",
"git_tag": "10.1.1"
}
],
"targets": [
{
"name": "mylib",
"type": "static",
"sources": ["src/lib.cpp"],
"include_dirs": ["include"],
"install": true
},
{
"name": "myapp",
"type": "executable",
"sources": ["src/main.cpp"],
"link_libraries": ["mylib", "Threads::Threads"],
"install": true
}
]
}
Project Recipes
Recipes use a category/variant naming convention:
buildgen project recipes
C++ Recipes (CMake + Makefile frontend):
| Recipe | Description |
|---|---|
cpp/executable |
Single executable |
cpp/static |
Static library |
cpp/shared |
Shared library (-fPIC) |
cpp/header-only |
Header-only library |
cpp/library-with-tests |
Library + tests |
cpp/app-with-lib |
App with internal library |
cpp/full |
Library + app + tests |
C Recipes (CMake + Makefile frontend):
| Recipe | Description |
|---|---|
c/executable |
Single executable |
c/static |
Static library |
c/shared |
Shared library (-fPIC) |
c/header-only |
Header-only library |
c/library-with-tests |
Library + tests |
c/app-with-lib |
App with internal library |
c/full |
Library + app + tests |
Python Extension Recipes (scikit-build-core):
| Recipe | Description |
|---|---|
py/pybind11 |
C++ extension using pybind11 |
py/nanobind |
C++ extension using nanobind |
py/cython |
Extension using Cython |
py/cext |
C extension (Python.h) |
Python Extension Projects
Generate complete Python extension projects with scikit-build-core:
# Create a pybind11 extension project
buildgen project init -n myext --recipe py/pybind11
# Use traditional virtualenv instead of uv
buildgen project init -n myext --recipe py/pybind11 --env venv
This creates a complete project structure:
myext/
pyproject.toml # scikit-build-core configuration
CMakeLists.txt # CMake build instructions
Makefile # Convenience wrapper
src/myext/
__init__.py # Python package
_core.cpp # C++ extension source
tests/
test_myext.py # pytest tests
The generated Makefile provides convenient commands (using uv by default):
make sync # Initial setup (uv sync)
make build # Rebuild extension after code changes
make test # Run tests (uv run pytest)
make wheel # Build wheel distribution
make clean # Remove build artifacts
For traditional virtualenv workflows, use --env venv to generate pip/python commands instead.
Template Customization
Templates can be customized without modifying buildgen. Override files are resolved in this order (first match wins):
$BUILDGEN_TEMPLATES/{recipe}/- Environment variable (for CI/CD).buildgen/templates/{recipe}/- Project-local overrides~/.buildgen/templates/{recipe}/- User-global defaults- Built-in templates
Template Commands
# List available templates and show which have overrides
buildgen templates list
# Copy templates for local customization
buildgen templates copy py/pybind11
# Copy to global location for user-wide defaults
buildgen templates copy py/pybind11 --global
# Show where each template file is resolved from
buildgen templates show py/pybind11
Customizing Templates
-
Copy the templates you want to customize:
buildgen templates copy py/pybind11
-
Edit the
.makofiles in.buildgen/templates/py/pybind11/:# Customize pyproject.toml template edit .buildgen/templates/py/pybind11/pyproject.toml.mako
-
Generate projects - your customizations will be used:
buildgen project init -n myext --recipe py/pybind11
Templates use Mako syntax with ${variable} for substitution.
Per-File Overrides
You can override individual files while keeping others from built-in templates. For example, to customize only pyproject.toml:
mkdir -p .buildgen/templates/py/pybind11
cp $(buildgen templates show py/pybind11 | grep pyproject) .buildgen/templates/py/pybind11/
# Edit your local copy
Low-Level API
For fine-grained control, use the generators directly:
from buildgen import MakefileGenerator, CMakeListsGenerator
# Makefile
gen = MakefileGenerator("Makefile")
gen.add_cxxflags("-Wall", "-std=c++17")
gen.add_target("myapp", "$(CXX) $(CXXFLAGS) -o $@ $^", deps=["main.o"])
gen.add_pattern_rule("%.o", "%.cpp", "$(CXX) $(CXXFLAGS) -c $< -o $@")
gen.add_phony("all", "clean")
gen.generate()
# CMake
gen = CMakeListsGenerator("CMakeLists.txt")
gen.set_project("myapp", version="1.0.0")
gen.set_cxx_standard(17)
gen.add_find_package("Threads", required=True)
gen.add_executable("myapp", ["src/main.cpp"], link_libraries=["Threads::Threads"])
gen.generate()
Development
make test # Run tests
make lint # Run ruff check
make coverage # Coverage report
Credits
- Template rendering powered by an embedded version of Mako Templates (MIT License)
- Originally inspired by prior work in
shedskin.makefilein the shedskin project
License
GPL-3.0-or-later
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 buildgen-0.1.4.tar.gz.
File metadata
- Download URL: buildgen-0.1.4.tar.gz
- Upload date:
- Size: 99.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
25fb88ea7188adc22e192b273cab7b03c01634018668442509faf29ac076dc71
|
|
| MD5 |
5380c777e7306774cdc538d5f3d14afa
|
|
| BLAKE2b-256 |
e97fd5abb9b69886966343f5670e2a6962b597fe8f3bcdd48a79e43ae98b63bf
|
File details
Details for the file buildgen-0.1.4-py3-none-any.whl.
File metadata
- Download URL: buildgen-0.1.4-py3-none-any.whl
- Upload date:
- Size: 152.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cac58c0deed3534ca610b51a159a7193e7f231a0e525190183b970ec07e1d761
|
|
| MD5 |
6b7ff8ede2fe6effc7ee2634638ec97d
|
|
| BLAKE2b-256 |
156bd3d74c481188981d8f31cadf9b974de278b186898bc22dda0abfb8f2ec8f
|