Metadata-Version: 1.1
Name: retox
Version: 1.5.0
Summary: A parallel service for tox
Home-page: https://github.com/tonybaloney/retox
Author: Anthony Shaw
Author-email: UNKNOWN
License: MIT
Description-Content-Type: UNKNOWN
Description: Retox
        =====
        
        .. image:: https://img.shields.io/pypi/v/retox.svg
                :target: https://pypi.python.org/pypi/retox
        
        .. image:: https://img.shields.io/travis/tonybaloney/retox.svg
                :target: https://travis-ci.org/tonybaloney/retox
        
        .. image:: https://codecov.io/gh/tonybaloney/retox/branch/master/graph/badge.svg
                :target: https://codecov.io/gh/tonybaloney/retox
        
        .. image:: https://pyup.io/repos/github/tonybaloney/retox/shield.svg
             :target: https://pyup.io/repos/github/tonybaloney/retox/
             :alt: Updates
        
        .. image:: https://pyup.io/repos/github/tonybaloney/retox/python-3-shield.svg
             :target: https://pyup.io/repos/github/tonybaloney/retox/
             :alt: Python 3
        
        A command line service that runs your tox tests in parallel, using threading and multicore CPUs.
        
        See your tox environments in a dashboard and automatically watch source folders for file changes and re-run tests.
        
        See : https://github.com/tonybaloney/retox/raw/master/docs/_static/screenshot.jpeg for an example screenshot
        
        .. image:: https://github.com/tonybaloney/retox/raw/master/docs/_static/retox_demo.gif
        
        Requirements
        ------------
        
        Linux users may need to install libncurses5-dev before using Tox. If you see an error "ImportError: No module named '_curses'" this is because of the Requirement.
        
        Usage
        -----
        
        To install, run 
        
        .. code-block:: bash
        
            pip install retox
        
        Then from any project that has a `tox.ini` file setup and using tox, you can simply run
        
        .. code-block:: bash
        
            retox 
        
        This will start the service, from where you can press (b) to rebuild on demand.
        
        Watching folders
        ----------------
        
        Retox can watch one or many directories for file changes and re-run the tox environments when changes are detected
        
        .. code-block:: bash
        
            retox -w my_project_folder -w my_test_folder
        
        Excluding paths
        ---------------
        
        Retox will ignore files matching a given regex:
        
        .. code-block:: bash
        
            retox -w my_project_folder --exclude='.*\.(swp|pyc)$'
        
        Tox support
        -----------
        
        Any tox arguments can be given to the command, and using --help to get a full list of commands. Tox arguments will be passed to all virtualenvs
        
        .. code-block:: bash
        
            retox -e py27,py36
        
        multicore configuration
        -----------------------
        
        The number of concurrent processes in the threadpool can be set using the -n parameter.
        By default this will be equal to the number of CPU's on the OS. If you want to expand or throttle this, use the
        flag to change the size of the threadpool.
        
        .. code-block:: bash
        
            retox -n 4
        
        Logging
        -------
        
        2 files will be created - .retox.log, which is a file for all runs of the logs for the virtual environments. This can be handy to tail to see live output
        .retox.json - a JSON file with the virtualenv tasks and specific command output.
        
        Credits
        -------
        
        This was inspired by the detox project, which was created by the tox development team. I worked and then significantly changed the way it works
        to support re-running environments with ease.
        
Platform: unix
Platform: linux
Platform: osx
Platform: cygwin
Platform: win32
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python
