Skip to main content

Scaffold and build Python C extensions with CMake and just-buildit.

Project description

just-makeit

CI Docs

Getting an algorithm right is paramount. Yet it's rarely the bottleneck. Turning it into shippable code — a tested C library, a Python binding, a build system, packaging, and a public C API that Rust or C++ can also link — is the tedious, exacting work that repeats on every project.

just-makeit new scaffolds the whole thing in one command: core C library, thin Python binding, CMake build system, and full test coverage — all passing before you write a single line of your algorithm.


Try it now!

Open in GitHub Codespaces

Click the badge to launch a pre-built sandbox in your browser — no install, no compiler, no Docker required. You'll land in a GitHub Codespaces environment with just-makeit installed, all nine bundled examples already scaffolded and compiled, and a terminal ready to go. Run an example end-to-end, browse the generated C and Python source, or start a fresh project with just-makeit new.


Quickstart

curl (auto-installs dependencies, creates and activates venv):

. <(curl -fsSL https://just-buildit.github.io/just-makeit/install.sh) [-- path]

pip:

pip install just-makeit && just-makeit install-deps [-- path]

uv:

uv tool install just-makeit && just-makeit install-deps [-- path]

Docker (no install needed):

docker run --rm -it ghcr.io/just-buildit/jm-examples-linux:latest

Quick examples

Simple standalone extension:

just-makeit new my_project --object engine --state gain:double:1.0
cd my_project && make && make test

Module subpackage — multiple types in one .so:

just-makeit new my_filters --module filter
cd my_filters
just-makeit object fir    --module filter \
    --state "coeffs:float[16]" --state "delay:float _Complex[16]" --state "gain:float:1.0"
just-makeit object biquad --module filter \
    --arg-type float --return-type float \
    --state "b0:double:1.0" --state "b1:double:0.0" --state "a1:double:0.0"
make && make test
from my_filters.filter import Fir, Biquad   # one .so, one import

What you get

my_project/
├── native/
│   ├── inc/engine/engine_core.h   # public C API + inline step()
│   ├── src/engine/
│   │   ├── engine_core.c          # block processor + lifecycle
│   │   └── engine_ext.c           # thin Python binding
│   └── tests/test_engine_core.c   # CTest
├── src/my_project/
│   ├── engine.pyi                 # type stub
│   └── tests/test_engine.py       # pytest / unittest
├── cmake/my-project.pc.in         # pkg-config template
├── CMakeLists.txt
├── Makefile
└── just-makeit.toml

C API

engine_state_t *engine_create(double gain);
void            engine_destroy(engine_state_t *state);
void            engine_reset(engine_state_t *state);

static inline float complex
engine_step(const engine_state_t *state, float complex x);

void engine_steps(engine_state_t *state,
                  const float complex *in, float complex *out, size_t n);

double engine_get_gain(const engine_state_t *state);
void   engine_set_gain(engine_state_t *state, double gain);

Python API

from my_project import Engine
import numpy as np

obj = Engine(gain=2.0)

y = obj.step(1.0 + 0.5j)

x = np.ones(1024, dtype=np.complex64)
y = obj.steps(x)          # allocates output ndarray
obj.steps(x, out=y)       # zero-copy

obj.set_gain(0.5)
obj.reset()

with Engine() as e:
    y = e.steps(x)

Requirements

  • Python 3.11+
  • CMake ≥ 3.16
  • A C99 compiler (GCC, Clang, MSVC/MinGW)
  • NumPy (runtime, for generated projects)

Full documentation →

Authors

Matthew T. Hunter, Ph.D. and Claude Code

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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

just_makeit-0.13.5-py3-none-any.whl (334.6 kB view details)

Uploaded Python 3

File details

Details for the file just_makeit-0.13.5-py3-none-any.whl.

File metadata

  • Download URL: just_makeit-0.13.5-py3-none-any.whl
  • Upload date:
  • Size: 334.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for just_makeit-0.13.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a58e0d00e1ad87b038cdee5b9591d956e78c9d1e914a5648713d5b7d670d9fb1
MD5 276a7060532d4c56b723bb0e01b9d0bb
BLAKE2b-256 b91c327e436fffa5bf863c8d43ca935d7b5dfd61e5b30438c7099ecf0b98bb10

See more details on using hashes here.

Provenance

The following attestation bundles were made for just_makeit-0.13.5-py3-none-any.whl:

Publisher: release.yml on just-buildit/just-makeit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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