Skip to main content

A Python-based build system that generates Ninja files

Project description

Pcons

A modern Python-based build system that generates Ninja (or Makefile) build files.

CI

Overview

Pcons is inspired by SCons and CMake, taking the best ideas from each:

  • From SCons: Environments, Tools, dependency tracking, Python as the configuration language
  • From CMake: Generator architecture (configure once, build fast), usage requirements that propagate through dependencies

Key design principles:

  • Configuration, not execution: Pcons generates Ninja files; Ninja executes the build
  • Python is the language: No custom DSL—build scripts are real Python with full IDE support
  • Language-agnostic: Build C++, Rust, LaTeX, protobuf, or anything else
  • Explicit over implicit: Dependencies are discoverable and traceable

Status

🚧 Under active development - ready for experimentation and feedback.

Core functionality is working: C/C++ compilation, static and shared libraries, programs, and install targets. See ARCHITECTURE.md for design details.

Quick Example

# pcons-build.py
from pcons.core.project import Project
from pcons.toolchains import find_c_toolchain

project = Project("myapp", build_dir="build")

# Find and configure a C/C++ toolchain
toolchain = find_c_toolchain()
env = project.Environment(toolchain=toolchain)
env.cc.flags.extend(["-Wall"])

# Build a static library
lib = project.StaticLibrary("core", env)
lib.sources.append(project.node("src/core.c"))
lib.public.include_dirs.append(Path("include"))

# Build a program
app = project.Program("myapp", env)
app.sources.append(project.node("src/main.c"))
app.link(lib)

project.Default(app)
project.resolve()
project.generate()
uv run pcons-build.py
ninja -C build

Installation

No installation needed, if you have uv; just use uvx pcons to configure and build. uvx pcons --help for more info. If you want to install it, though:

# Using uv
uv add pcons

# Or pip
pip install pcons

For development:

git clone https://github.com/garyo/pcons.git
cd pcons
uv sync

Documentation

Development

# Run tests
uv run pytest

# Run linter
make lint

# Format code
make fmt

# Or use uv directly
uv run ruff check pcons/
uv run mypy pcons/

License

MIT License - see LICENSE

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

pcons-0.4.2.tar.gz (382.3 kB view details)

Uploaded Source

Built Distribution

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

pcons-0.4.2-py3-none-any.whl (204.7 kB view details)

Uploaded Python 3

File details

Details for the file pcons-0.4.2.tar.gz.

File metadata

  • Download URL: pcons-0.4.2.tar.gz
  • Upload date:
  • Size: 382.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for pcons-0.4.2.tar.gz
Algorithm Hash digest
SHA256 29a135056c6982cf136ed2b0657baf69d5fadbb2f89e245f6f7c74d4a510f450
MD5 77207f8898c520f7fc21213ccbfdc5d8
BLAKE2b-256 051eb02b19ec9714bd4e56c6a1d42d0e869f32b39dfc6fcca1426f4891826e67

See more details on using hashes here.

File details

Details for the file pcons-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: pcons-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 204.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for pcons-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 acbffe30fac77b6ae99ea28b8cfe7e663b5d1c64dddb1345af0ba71deec27a0a
MD5 d2db25b872d69258f081e33d689a8d7d
BLAKE2b-256 319bee8b86ba20a31d5b97814b7b5402243d5fd4ee758f969c27d24b6d338cac

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