Install package with pip¶

To install with pip:

$ pip install scikit-build

Install from source¶

To install scikit-build from the latest source, first obtain the source code:

$ git clone https://github.com/scikit-build/scikit-build
$ cd scikit-build

then install with:

$ pip install .

or:

$ pip install -e .

for development.

Dependencies¶

wheel==0.29.0
setuptools==26.1.1

codecov==2.0.5
coverage==4.2
cython==0.24.1
flake8==3.0.4
pytest==3.0.2
pytest-cov==2.3.1
pytest-mock==1.2
pytest-runner==2.9
six==1.10.0

$ sudo apt-get install build-essential

Basic usage¶

To use scikit-build in a project, place the following in your project’s setup.py file:

# This line replaces 'from setuptools import setup'
from skbuild import setup

Now, your project will use scikit-build instead of setuptools.

Controlling CMake using scikit-build¶

Alternatively, you can drive CMake more directly yourself using scikit-build:

""" Use scikit-build's `cmaker` to control CMake configuration and build.

1. Use `cmaker` to define an object that provides convenient access to
   CMake's configure and build functionality.

2. Use defined object, `maker`, to call `configure()` to read the
   `CMakeLists.txt` file in the current directory and generate a Makefile,
   Visual Studio solution, or whatever is appropriate for your platform.

3. Call `make()` on the object to execute the build with the
   appropriate build tool and perform installation to the local directory.
"""
from skbuild import cmaker
maker = cmaker.CMaker()

maker.configure()

maker.make()

Examples for scikit-build developers¶

Types of Contributions¶

You can contribute in many ways:

Get Started¶

Ready to contribute? Here’s how to set up scikit-build for local development.

1. Fork the scikit-build repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/scikit-build.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed (pip install virtualenvwrapper), this is how you set up your cloned fork for local development:

   $ mkvirtualenv scikit-build
   $ cd scikit-build/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 skbuild tests
   $ python setup.py test
   $ tox
   

   If needed, you can get flake8 and tox by using pip install to install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.7, and 3.3, 3.4, 3.5 and PyPy. Check https://travis-ci.org/scikit-build/scikit-build/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_skbuild