Skip to main content

A Tox plugin that builds and installs wheels instead of sdist.

Project description

A tox plugin that builds and installs wheels instead of sdist.

  • Free software: BSD 2-Clause License

What does this plugin actually do? What it doesn’t?

  • It builds wheels for all the active environments. Unfortunately it’s done in a batch before any testing starts (in order to support tox --parallel mode).

    However, you can configure it so it builds only once, if your project can build universal wheels.

  • Universal wheels are not detected.

  • No support for pyproject.toml yet.

What projects use this?

  • hunter (also publishes the wheels built by this plugin)

Installation

pip install tox-wheel

Documentation

Two ways to use:

  • Run tox --wheel

  • Have this in your tox.ini:

    [testenv]
    wheel = true

Additional settings:

  • You can also disable build directory removal (dirty builds, use at your own peril):

    [testenv]
    wheel_clean_build = false
  • By default the build environment is the same environment that the wheel gets installed to. You can change it, eg:

    [tox]
    envlist = py27{,-build}
    
    [testenv]
    wheel_build_env = {envname}-build
    deps =
        build: cython

    Or, if you have universal wheels you can have a single build env:

    [testenv]
    wheel_build_env = build
    
    [testenv:build]
    deps = setuptools_scm

Development

To run the all tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows

set PYTEST_ADDOPTS=--cov-append
tox

Other

PYTEST_ADDOPTS=--cov-append tox

Changelog

0.4.1 (2019-05-15)

  • Improved error handling when no dists are built.

0.4.0 (2019-05-05)

  • Fixed compatibility with tox and changed requirement for minimum tox version to 3.9.0.

0.3.0 (2019-01-26)

  • Added support for tox --parallel mode.

  • Added wheel_build_env config option.

  • Renamed wheel_clean_build config option to wheel_dirty.

  • Added --wheel-dirty CLI argument.

0.2.1 (2019-01-12)

  • Added wheel to dependencies.

0.2.0 (2019-01-12)

  • Remove --wheel-clean-build CLI option. Build directory cleaning is now on by default. Correct behavior should be the default.

  • Added support for [testenv] wheel (default: false) and [testenv] wheel_clean_build (default: true) in tox.ini.

0.1.0 (2019-01-09)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tox-wheel-0.4.1.tar.gz (16.4 kB view hashes)

Uploaded Source

Built Distribution

tox_wheel-0.4.1-py2.py3-none-any.whl (5.6 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page