Quick Start
Contributors: This Release
Synopsis
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 
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
Configure
Simply run
scons config [options]
to prepare a build. See scons -h for a description of the available options. For example
scons config --boost=/path/to/boost --python=/path/to/python
will configure Boost.Python to be built against the two specific versions of Boost and Python.
Build
Run
scons
to build the library.
Test
Run
scons test
to run the tests.
Build docs
Run
scons doc
to build the documentation.
<p><img src="https://raw.githubusercontent.com/boostorg/python/develop/doc/images/bpl.png" alt="logo" /></p> <h1>Synopsis</h1> <p>Welcome to Boost.Python, a C++ library which enables seamless interoperability between C++ and the Python programming language. The library includes support for:</p> <ul> <li>References and Pointers</li> <li>Globally Registered Type Coercions</li> <li>Automatic Cross-Module Type Conversions</li> <li>Efficient Function Overloading</li> <li>C++ to Python Exception Translation</li> <li>Default Arguments</li> <li>Keyword Arguments</li> <li>Manipulating Python objects in C++</li> <li>Exporting C++ Iterators as Python Iterators</li> <li>Documentation Strings</li> </ul> <p>See the <a href="http://boostorg.github.io/python">Boost.Python</a> documentation for details.</p> <p><strong>Hint :</strong> Check out the <a href="http://boostorg.github.io/python/develop">development version</a> of the documentation to see work in progress.</p> <h1>Building <img src="https://travis-ci.org/boostorg/python.svg?branch=develop" alt="Build Status" /></h1> <p>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.</p> <h2>Prerequisites</h2> <ul> <li><a href="http://www.python.org">Python</a></li> <li><a href="http://www.boost.org">Boost</a></li> <li><a href="http://www.scons.org">SCons</a></li> </ul> <h2>Configure</h2> <p>Simply run</p> <pre class="highlightjs highlight"><code class="language- hljs">scons config [options] </code></pre> <p>to prepare a build. See <code>scons -h</code> for a description of the available options. For example</p> <pre class="highlightjs highlight"><code class="language- hljs">scons config --boost=/path/to/boost --python=/path/to/python </code></pre> <p>will configure Boost.Python to be built against the two specific versions of Boost and Python.</p> <h2>Build</h2> <p>Run</p> <pre class="highlightjs highlight"><code class="language- hljs">scons </code></pre> <p>to build the library.</p> <h2>Test</h2> <p>Run</p> <pre class="highlightjs highlight"><code class="language- hljs">scons test </code></pre> <p>to run the tests.</p> <h2>Build docs</h2> <p>Run</p> <pre class="highlightjs highlight"><code class="language- hljs">scons doc </code></pre> <p>to build the documentation.</p>
-
Code Commits Commits authored to any Boost repository. With 1 contribution, you will earn the bronze badge for Code Commits.
-
Documentation Doc contributions using standardised Boost tooling (Antora / BoostLook). With 1 contribution, you will earn the bronze badge for Documentation.
-
Library Authoring Authored an original Boost library accepted into the collection. With 1 contribution, you will earn the bronze badge for Library Authoring.
-
Library Maintenance Number of libraries actively maintained. With 1 contribution, you will earn the bronze badge for Library Maintenance.
-
Library Review Formal review submissions on Boost proposals. With 1 contribution, you will earn the bronze badge for Library Review.
-
Library Versioning Authored new versions / releases of Boost libraries. With 10 contributions, you will earn the bronze badge for Library Versioning.
-
Mailing List Participation Participation on the Boost developers mailing list. With 1 contribution, you will earn the bronze badge for Mailing List Participation.
-
News Posts Published Articles / news posts published on Boost.org. With 1 contribution, you will earn the bronze badge for News Posts Published.
<p><img src="https://raw.githubusercontent.com/boostorg/python/develop/doc/images/bpl.png" alt="logo" /></p> <h1>Synopsis</h1> <p>Welcome to Boost.Python, a C++ library which enables seamless interoperability between C++ and the Python programming language. The library includes support for:</p> <ul> <li>References and Pointers</li> <li>Globally Registered Type Coercions</li> <li>Automatic Cross-Module Type Conversions</li> <li>Efficient Function Overloading</li> <li>C++ to Python Exception Translation</li> <li>Default Arguments</li> <li>Keyword Arguments</li> <li>Manipulating Python objects in C++</li> <li>Exporting C++ Iterators as Python Iterators</li> <li>Documentation Strings</li> </ul> <p>See the <a href="http://boostorg.github.io/python">Boost.Python</a> documentation for details.</p> <p><strong>Hint :</strong> Check out the <a href="http://boostorg.github.io/python/develop">development version</a> of the documentation to see work in progress.</p> <h1>Building <img src="https://travis-ci.org/boostorg/python.svg?branch=develop" alt="Build Status" /></h1> <p>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.</p> <h2>Prerequisites</h2> <ul> <li><a href="http://www.python.org">Python</a></li> <li><a href="http://www.boost.org">Boost</a></li> <li><a href="http://www.scons.org">SCons</a></li> </ul> <h2>Configure</h2> <p>Simply run</p> <pre class="highlightjs highlight"><code class="language- hljs">scons config [options] </code></pre> <p>to prepare a build. See <code>scons -h</code> for a description of the available options. For example</p> <pre class="highlightjs highlight"><code class="language- hljs">scons config --boost=/path/to/boost --python=/path/to/python </code></pre> <p>will configure Boost.Python to be built against the two specific versions of Boost and Python.</p> <h2>Build</h2> <p>Run</p> <pre class="highlightjs highlight"><code class="language- hljs">scons </code></pre> <p>to build the library.</p> <h2>Test</h2> <p>Run</p> <pre class="highlightjs highlight"><code class="language- hljs">scons test </code></pre> <p>to run the tests.</p> <h2>Build docs</h2> <p>Run</p> <pre class="highlightjs highlight"><code class="language- hljs">scons doc </code></pre> <p>to build the documentation.</p>
-
Achievement-based Reflects the depth of your contributions. Accumulate achievements to unlock five tiers; Bronze, Silver, Gold, Platinum and Diamond.
-
Tenure-based Awarded in recognition of your time on the platform. The longer you've been part of the Boost community, the higher the tier you unlock.
-
Boost day celebration A celebration of the day you joined Boost. Awarded annually to mark another year as part of the community.
