mixxx-bisect


Namemixxx-bisect JSON
Version 0.4.1 PyPI version JSON
download
home_page
SummaryFinds Mixxx regressions by binary searching over prebuilt snapshots
upload_time2023-12-23 18:43:50
maintainer
docs_urlNone
author
requires_python>=3.9
licenseMIT 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.
keywords mixxx bisect regression
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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]
> The [mixxx.org downloads server](https://downloads.mixxx.org/) only provides binary snapshots for macOS and Windows, therefore [`m1xxx`](https://github.com/fwcd/m1xxx) is the only supported snapshot repository on Linux.

## 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.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "mixxx-bisect",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "mixxx,bisect,regression",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/42/c4/4a5f43909fcd8159da18993a83db4f59db33328de8ff5a1d1244467a3628/mixxx-bisect-0.4.1.tar.gz",
    "platform": null,
    "description": "# Mixxx Bisect\n\n[![PyPI](https://img.shields.io/pypi/v/mixxx-bisect)](https://pypi.org/project/mixxx-bisect)\n[![Typecheck](https://github.com/fwcd/mixxx-bisect/actions/workflows/typecheck.yml/badge.svg)](https://github.com/fwcd/mixxx-bisect/actions/workflows/typecheck.yml)\n\nA 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.\n\n> [!NOTE]\n> The [mixxx.org downloads server](https://downloads.mixxx.org/) only provides binary snapshots for macOS and Windows, therefore [`m1xxx`](https://github.com/fwcd/m1xxx) is the only supported snapshot repository on Linux.\n\n## Usage\n\nTo search a specific range of commits, run:\n\n```sh\nmixxx-bisect -g <good commit> -b <bad commit>\n```\n\nTo search the entire range of available snapshots, run `mixxx-bisect` without arguments.\n\n## Development\n\nTo set up a development environment, create a venv with\n\n```sh\npython3 -m venv venv\n. venv/bin/activate\n```\n\nThen, install the package along with its dependencies in editable mode:\n\n```sh\npip3 install -e .\n```\n\n`mixxx-bisect` should now be on the `PATH` in the venv.\n",
    "bugtrack_url": null,
    "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. ",
    "summary": "Finds Mixxx regressions by binary searching over prebuilt snapshots",
    "version": "0.4.1",
    "project_urls": {
        "Homepage": "https://github.com/fwcd/mixxx-bisect",
        "Repository": "https://github.com/fwcd/mixxx-bisect"
    },
    "split_keywords": [
        "mixxx",
        "bisect",
        "regression"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "42c44a5f43909fcd8159da18993a83db4f59db33328de8ff5a1d1244467a3628",
                "md5": "9c9de9fada9b41e13f7d227d1a54bdfb",
                "sha256": "7a663eaed0f0778cd9f7a5a38cfb3a68b3b1dbdc8d683dbcca0de056acad46b1"
            },
            "downloads": -1,
            "filename": "mixxx-bisect-0.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "9c9de9fada9b41e13f7d227d1a54bdfb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 10675,
            "upload_time": "2023-12-23T18:43:50",
            "upload_time_iso_8601": "2023-12-23T18:43:50.615538Z",
            "url": "https://files.pythonhosted.org/packages/42/c4/4a5f43909fcd8159da18993a83db4f59db33328de8ff5a1d1244467a3628/mixxx-bisect-0.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-23 18:43:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "fwcd",
    "github_project": "mixxx-bisect",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "mixxx-bisect"
}
        
Elapsed time: 0.16790s