scons-tool-swigpy 0.1.2

From pypi

This method may be preferable if you build your project under a virtualenv. To add swigpy tool from pypi, type (within your wirtualenv):

pip install scons-tool-loader scons-tool-swigpy

or, if your project uses pipenv:

pipenv install --dev scons-tool-loader scons-tool-swigpy

Alternatively, you may add this to your Pipfile

[dev-packages]
scons-tool-loader = "*"
scons-tool-swigpy = "*"

The tool will be installed as a namespaced package sconstool.swigpy in project’s virtual environment. You may further use scons-tool-loader to load the tool.

As a git submodule

1. Create new git repository:

   mkdir /tmp/prj && cd /tmp/prj
   touch README.rst
   git init

2. Add the scons-tool-swigpy as a submodule:

   git submodule add git://github.com/ptomulik/scons-tool-swigpy.git site_scons/site_tools/swigpy

3. For python 2.x create __init__.py in site_tools directory:

   touch site_scons/site_tools/__init__.py

   this will allow to directly import site_tools.swigpy (this may be required by other tools).

Module description

The module provides a SwigPyModule() builder which generates python module based on a swig interface *.i file:

SwigPyModule(modname, **overrides)

The modname is a name of the module being generated, for example 'foo' or 'foo.bar' (note, it’s neither the source file name nor target file name). The overrides overwrite construction variables such as SWIGFLAGS or CFLAGS.

Example 1:

The following code expects a foo.i interface file to be present and generates python module defined by this file.

SwigPyModule('foo')

Example 2:

The following code expects a foo/bar.i interface file to be present and generates python module defined by this file undef foo subdirectory.

SwigPyModule('foo.bar')

Construction variables

Construction variables used by SwigPyModule are summarized in the following table. Note that there are two groups of variables. The first group are the well known variables such as CFLAGS or SWIGFLAGS. The second group are the variables prefixed with SWIGPY_. These variables, if defined, overwrite the well known variables when generating python bindings.

The SWIGPY_M2SWIGFILE lambda determines the name of swig interface (source file). The SWIGPY_M2CFILE determines the name (without suffix) of the C or C++ wrapper file being generated by swig. The SWIGPY_M2SHLIBFILE determines the name of shared library that will contain the wrapper binary code after compilation (without prefix and suffix). The parts provided to any of these macros are the parts of modname, that is they’re result of modname.split('.').