Skip to main content

Professional C++ Python bindings with type-generic templates and native threading

Project description

IncludeCPP - Professional C++ Python Bindings

Professional C++ ↔ Python binding system with type-generic templates, native threading support, and maximum performance.

Features

  • Type-Generic System: Functions work with ANY type automatically

    algorithms.fast_sort([1,2,3])      # int version
    algorithms.fast_sort([1.5, 2.3])   # float version
    algorithms.fast_sort(["a","b"])    # string version
    
  • Native Threading with GIL Release: True parallelism

    game = CPP.include("threading").GameEngine()
    CPP.threadThis(game)  # Runs in C++ thread with GIL released
    
  • Dynamic Configuration: cpp.proj JSON configuration

  • AppData Build System: Clean separation of project and build artifacts

  • CLI Tool: includecpp --rebuild for easy building

  • Zero Overhead: Template instantiation eliminates runtime overhead

Installation

pip install IncludeCPP

Quick Start

1. Initialize Project

cd YourProject
includecpp init

This creates:

  • cpp.proj - Configuration file
  • include/ - Your C++ source files
  • plugins/ - Plugin definitions (.cp files)

2. Create C++ Module

include/mymodule.cpp:

#include <vector>
#include <algorithm>

namespace includecpp {

std::vector<int> custom_sort(const std::vector<int>& data) {
    std::vector<int> result = data;
    std::sort(result.begin(), result.end());
    return result;
}

}

plugins/mymodule.cp:

SOURCE(include/mymodule.cpp) mymodule

PUBLIC(
    mymodule FUNC(custom_sort)
)

3. Build

includecpp --rebuild

Build artifacts go to:

  • Windows: %APPDATA%/YourProject&gcc-build-proj/
  • Linux: ~/.local/share/includecpp/YourProject&gcc-build-proj/

4. Use in Python

import IncludeCPP as cpp

CPP = cpp.CppApi()
CPP.noFeedback()  # Disable warnings

mymodule = CPP.include("mymodule")
result = mymodule.custom_sort([5, 2, 9, 1])
print(result)  # [1, 2, 5, 9]

Type-Generic Templates

# plugins/algorithms.cp
SOURCE(include/algorithms.cpp) && HEADER(include/algorithms.h) algorithms

PUBLIC(
    algorithms TEMPLATE_FUNC(fast_sort) TYPES(int, float, double, string)
)

Configuration

cpp.proj (auto-created by includecpp init):

{
  "project": "MyProject",
  "version": "1.0.0",
  "include": "/include",
  "plugins": "/plugins",
  "compiler": {
    "standard": "c++17",
    "optimization": "O3",
    "flags": ["-Wall", "-pthread"]
  }
}

Requirements

  • Python >= 3.8
  • C++ compiler (g++, clang++, or MSVC)
  • pybind11 >= 2.11.0
  • CMake >= 3.15

License

MIT License

Links

Example: Complete Module

See the examples/ directory for complete working examples including:

  • Type-generic algorithms
  • Threading with GIL release
  • Map and Array containers
  • Custom C++ classes

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

includecpp-1.1.4.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

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

includecpp-1.1.4-py3-none-any.whl (20.7 kB view details)

Uploaded Python 3

File details

Details for the file includecpp-1.1.4.tar.gz.

File metadata

  • Download URL: includecpp-1.1.4.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for includecpp-1.1.4.tar.gz
Algorithm Hash digest
SHA256 e57df17dbf89c56255511bb8270ac74782499c6474445f9f456dcd357fa9a1c3
MD5 7de5a79330a15619c96d8f3b37c90dc4
BLAKE2b-256 8ec6800d9c4663bc3dfb2089edab1b55801c9d8f86c14c0f355c5a61bde48718

See more details on using hashes here.

File details

Details for the file includecpp-1.1.4-py3-none-any.whl.

File metadata

  • Download URL: includecpp-1.1.4-py3-none-any.whl
  • Upload date:
  • Size: 20.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for includecpp-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 59d85d758cbc5217961fcc98f54e2a94bcb306ee44e1ffdda9a9ae57c31ca1c6
MD5 258d642cd9d92436fb151684be71fa58
BLAKE2b-256 205e2b3373eaeed692c15493a7046b9d012638d01c5ed8edd019101264d07ecd

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