https://github.com/boostorg/python

Boost.org python module
https://github.com/boostorg/python

Last synced: 6 days ago
JSON representation

Boost.org python module

• Host: GitHub
• URL: https://github.com/boostorg/python
• Owner: boostorg
• License: bsl-1.0
• Created: 2013-01-13T15:59:06.000Z (about 12 years ago)
• Default Branch: develop
• Last Pushed: 2025-02-06T14:14:03.000Z (14 days ago)
• Last Synced: 2025-02-07T17:04:11.232Z (13 days ago)
• Language: C++
• Homepage: http://boostorg.github.io/python
• Size: 20 MB
• Stars: 489
• Watchers: 29
• Forks: 207
• Open Issues: 192
• Metadata Files:
  • Readme: README.md
  • License: LICENSE_1_0.txt

Awesome Lists containing this project

README

        
![logo](https://raw.githubusercontent.com/boostorg/python/develop/doc/images/bpl.png)

# Synopsis

[![Join the chat at https://gitter.im/boostorg/python](https://badges.gitter.im/boostorg/python.svg)](https://gitter.im/boostorg/python?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Welcome to Boost.Python, a C++ library which enables seamless interoperability between C++ and the Python programming language. The library includes support for:

* References and Pointers

* Globally Registered Type Coercions

* Automatic Cross-Module Type Conversions

* Efficient Function Overloading

* C++ to Python Exception Translation

* Default Arguments

* Keyword Arguments

* Manipulating Python objects in C++

* Exporting C++ Iterators as Python Iterators

* Documentation Strings

See the [Boost.Python](http://boostorg.github.io/python) documentation for details.

**Hint :** Check out the [development version](http://boostorg.github.io/python/develop) of the documentation to see work in progress.

# Building ![Test Ubuntu](https://github.com/boostorg/python/workflows/Test%20Ubuntu/badge.svg) ![Test OSX](https://github.com/boostorg/python/workflows/Test%20OSX/badge.svg) ![Test Windows](https://github.com/boostorg/python/workflows/Test%20Windows/badge.svg)

While Boost.Python is part of the Boost C++ Libraries super-project, and thus can be compiled as part of Boost, it can also be compiled and installed stand-alone, i.e. against a pre-installed Boost package.

## Prerequisites

* [Python](http://www.python.org)

* [Boost](http://www.boost.org)

* [Faber](https://stefanseefeld.github.io/faber)

## Build

Run

```

faber

```

to build the library.

## Test

Run

```

faber test.report

```

to run the tests.

## Build docs

Run

```

faber doc.html

```

to build the documentation.