diff options
Diffstat (limited to 'src/boost/libs/python/README.md')
| -rw-r--r-- | src/boost/libs/python/README.md | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/src/boost/libs/python/README.md b/src/boost/libs/python/README.md new file mode 100644 index 000000000..7646d3a87 --- /dev/null +++ b/src/boost/libs/python/README.md @@ -0,0 +1,60 @@ + + +# Synopsis + +[](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 [](https://travis-ci.org/boostorg/python) [](https://ci.appveyor.com/project/stefanseefeld/python/branch/develop) + + +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. |