Metadata-Version: 2.1
Name: mixxx-bisect
Version: 0.2.4
Summary: Finds Mixxx regressions by binary searching over prebuilt snapshots
License: MIT License
        
        Copyright (c) 2022 fwcd
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/fwcd/mixxx-bisect
Project-URL: Repository, https://github.com/fwcd/mixxx-bisect
Keywords: mixxx,bisect,regression
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests<3,>=2.31
Requires-Dist: beautifulsoup4<5,>=4.12
Requires-Dist: tqdm<5,>=4.66

# Mixxx Bisect

[![PyPI](https://img.shields.io/pypi/v/mixxx-bisect)](https://pypi.org/project/mixxx-bisect)
[![Typecheck](https://github.com/fwcd/mixxx-bisect/actions/workflows/typecheck.yml/badge.svg)](https://github.com/fwcd/mixxx-bisect/actions/workflows/typecheck.yml)

A small tool for finding regressions in [Mixxx](https://github.com/mixxxdj/mixxx), inspired by [`mozregression`](https://github.com/mozilla/mozregression). The tool binary searches over a commit range and lets the user tag automatically downloaded Mixxx snapshots with good/bad to identify the commit introducing the regression.

> **Note**: This tool currently only supports macOS and Windows, since the [Mixxx downloads server](https://downloads.mixxx.org/) does not seem to host binary distributions for Linux. The script should be easy to adapt for new OSes though.

## Usage

To search a specific range of commits, run:

```sh
mixxx-bisect -g <good commit> -b <bad commit>
```

To search the entire range of available snapshots, run `mixxx-bisect` without arguments.

## Development

To set up a development environment, create a venv with

```sh
python3 -m venv venv
. venv/bin/activate
```

Then, install the package along with its dependencies in editable mode:

```sh
pip3 install -e .
```

`mixxx-bisect` should now be on the `PATH` in the venv.
