python/README.md
The Gitter Badger 28e2c6512c Add Gitter badge
2018-05-03 10:19:01 -04:00

1.8 KiB

logo

Synopsis

Join the chat at https://gitter.im/boostorg/python

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 documentation for details.

Hint : Check out the development version of the documentation to see work in progress.

Building Build Status Build status

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

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.