Metadata-Version: 2.1
Name: tox-monorepo
Version: 0.1.0
Summary: A tox plugin built to allow sharing of a common tox.ini file across repositories with high package counts.
Home-page: https://github.com/Azure/azure-sdk-tools/
Author: Microsoft Corporation
Author-email: azuresdkengsysadmins@microsoft.com
License: MIT License
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](https://pypi.org/project/pip/) from [PyPI](https://pypi.org):
        
        ```
        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}
        {changedir}
        
        ```
        
        ### Env-Specific Config Values
        
        ```
        {commands}
        {commands_pre}
        {commands_post}
        {envdir}
        {changedir}
        {envtmpdir}
        
        ```
        
        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](https://github.com/Azure/azure-sdk-tools)
        along with `tox-monorepo` in the title.
Platform: UNKNOWN
Classifier: Framework :: tox
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
