• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1![logo](https://raw.githubusercontent.com/boostorg/python/develop/doc/images/bpl.png)
2
3# Synopsis
4
5[![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)
6
7Welcome to Boost.Python, a C++ library which enables seamless interoperability between C++ and the Python programming language. The library includes support for:
8
9* References and Pointers
10* Globally Registered Type Coercions
11* Automatic Cross-Module Type Conversions
12* Efficient Function Overloading
13* C++ to Python Exception Translation
14* Default Arguments
15* Keyword Arguments
16* Manipulating Python objects in C++
17* Exporting C++ Iterators as Python Iterators
18* Documentation Strings
19
20See the [Boost.Python](http://boostorg.github.io/python) documentation for details.
21
22**Hint :** Check out the [development version](http://boostorg.github.io/python/develop) of the documentation to see work in progress.
23
24# Building [![Build Status](https://travis-ci.org/boostorg/python.svg?branch=develop)](https://travis-ci.org/boostorg/python) [![Build status](https://ci.appveyor.com/api/projects/status/cgx9xma6v3gjav92/branch/develop?svg=true)](https://ci.appveyor.com/project/stefanseefeld/python/branch/develop)
25
26
27While 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.
28
29## Prerequisites
30
31* [Python](http://www.python.org)
32* [Boost](http://www.boost.org)
33* [Faber](https://stefanseefeld.github.io/faber)
34
35## Build
36
37Run
38
39```
40faber
41```
42to build the library.
43
44## Test
45
46Run
47
48```
49faber test.report
50```
51to run the tests.
52
53## Build docs
54
55Run
56
57```
58faber doc.html
59```
60to build the documentation.
61