Skip to main content

A tox plugin built to allow sharing of a common tox.ini file across repositories with high package counts.

Project description

tox-monorepo

This plugin changes {toxinidir} to be the directory that executes the tox command, rather than where the tox.ini actually lives on disk. This allows a monorepo to easily share a single tox.ini file rather than have to keep copies up to date.

Features

Once installed, tox-monorepo will actively post-process the loaded tox config and replace all instances of {toxinidir} with a reference to the current working directory.

Note that if there are any out-of-ordinary changes present within your tox config, it is highly likely that this plugin has not been tested with them. Reference Contributing section for how to reach out if issues crop up.

Requirements

Tested on tox 3.1+, Python 2.7+

Installation

You can install "tox-monorepo" via pip from PyPI:

pip install tox-monorepo

Usage

Install the plugin, then try to reference a tox config from within a package directory.

tox -c <otherpath>/to/tox.ini

Note that all the .tox folder + any environments are now created relative to the directory that executed tox.

Complete Set of Updated Config Values

Base Config Values:

{toxinidir}
{toxworkdir}
{temp_dir}
{setupdir}
{distdir}
{sdistsrc}
{logdir}

Env-Specific Config Values

{commands}
{commands_pre}
{commands_post}
{envdir}
{changedir}
{envtmpdir}
{envlogdir}

Contributing

Contributions are very welcome, though the plugin is extremely straightforward and shouldn't really require updates. Just submit a PR or an Issue on the the current repo!

License

Distributed under the terms of the MIT license, tox-monorepo is free and open source software.

Issues

If you encounter any problems, please file an issue along with tox-monorepo in the title.

Project details


Download files

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

Files for tox-monorepo, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size tox_monorepo-0.1.2-py2.py3-none-any.whl (3.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page