Skip to content

Latest commit

 

History

History
78 lines (55 loc) · 2.92 KB

build.rst

File metadata and controls

78 lines (55 loc) · 2.92 KB
Raw

Build and Install

Requirements

Boost

STPyV8 makes use of Boost.Python for interoperability.

Most Linux distributions provide easy to install Boost packages and this is the suggested way to install the library. If packages are not available for your distribution download or install the latest version of Boost and follow the getting started guide to build the library.

Python wheels

STPyV8 is avaliable on PyPI (starting from release v12.0.267.16) and officially supports Python 3.9+

Be aware that, starting from STPyV8 v12.0.267.14, installing boost-python and some other boost dependencies is not required anymore while it is still required if you're installing older versions (see later for details). Most Linux distributions and MacOS provide easy to install Boost packages and this is the suggested way to install the library in case you need it.

If you are planning to install a version older than v12.0.267.16 you should use one of the Python wheels provided at STPyV8 Releases <https://github.com/cloudflare/stpyv8/releases>. The wheels are automatically generated using Github Actions and multiple platforms and Python versions are supported. In such case, you need to download the zip file for the proper platform and Python version. Each zip file contains the ICU data file icudtl.dat and the wheel itself. First of all you should copy icudtl.data to the STPyV8 ICU data folder (Linux: /usr/share/stpyv8, MacOS: /Library/Application Support/STPyV8/) and then install/upgrade STPyV8 using pip.

For instance, the following steps show how to install on MacOS

$ unzip stpyv8-macos-10.15-python-3.9.zip
    Archive:  stpyv8-macos-10.15-python-3.9.zip
    inflating: stpyv8-macos-10.15-3.9/icudtl.dat
    inflating: stpyv8-macos-10.15-3.9/stpyv8-9.9.115.8-cp39-cp39-macosx_10_15_x86_64.whl
$ cd stpyv8-macos-10.15-3.9
$ sudo mv icudtl.dat /Library/Application\ Support/STPyV8
$ pip install --upgrade stpyv8-9.9.115.8-cp39-cp39-macosx_10_15_x86_64.whl
    Processing ./stpyv8-9.9.115.8-cp39-cp39-macosx_10_15_x86_64.whl
    Installing collected packages: stpyv8
    Successfully installed stpyv8-9.9.115.8

If no wheels are provided for your platform and Python version you are required to build STPyV8.

Build Steps

$ python setup.py build
$ sudo python setup.py install

Optionally you can run STPyV8 tests (pytest is required)

$ pytest tests

If you want to build a distribution package for Linux/Mac run setup.py with the bdist command

$ python setup.py bdist