nxdk-pgraph-test-runner


Namenxdk-pgraph-test-runner JSON
Version 0.1.17 PyPI version JSON
download
home_pageNone
SummaryExecutes and captures the results of https://github.com/abaire/nxdk_pgraph_tests in an emulator
upload_time2025-07-08 22:09:34
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords nv2a pgraph xbox xemu
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # nxdk-pgraph-test-runner

[![PyPI - Version](https://img.shields.io/pypi/v/nxdk-pgraph-test-runner.svg)](https://pypi.org/project/nxdk-pgraph-test-runner)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/nxdk-pgraph-test-runner.svg)](https://pypi.org/project/nxdk-pgraph-test-runner)

-----

## Table of Contents

- [Installation](#installation)
- [Configuration](#configuration)
- [License](#license)

## Purpose

This test harness utilizes
the [nxdk_pgraph_tests](https://github.com/abaire/nxdk_pgraph_tests) project to
exercise the NV2A 3D accelerator on the original Microsoft Xbox. The runner is
intended to be used with an emulator (e.g., [xemu](https://xemu.app)) and is
able to detect and recover from crashes.

## Installation

### Prerequisites

* An xbox emulator (e.g., [xemu](https://xemu.app)) - required

### pip installation

```console
# Optionally create a virtual env
#   pip -m venv .venv
#   source .venv/bin/activate

pip install nxdk-pgraph-test-runner

nxdk-pgraph-test-runner --help
```

## Configuration

A default config may be generated by running the `nxdk-pgraph-test-runner`
command.

### Emulator command line

`"emulator_command = /path/to/emulator {ISO}"`

The command may utilize the following macros:

* `{ISO}` - Replaced with the path to the `nxdk_pgraph_tests.iso` xiso file.

### Example invocation

This is a sample invocation that will run xemu against a previously downloaded
nxdk_pgraph_tests iso. It will create a `results` directory with the results of
the tests.

```shell
nxdk-pgraph-test-runner \
    --override-ftp-ip 10.0.2.2 \
    --iso-path ~/nxdk_pgraph_tests_xiso.iso \
    --emulator-command "/path/to/xemu -dvd_path \"{ISO}\"" \
    -I lo0
```

This assumes that xemu is configured to use NAT networking, so the IP reported
to the pgraph tester is set to the qemu `10.0.2.2` host address and the loopback
interface (-I `lo0`) is used.

## License

`nxdk-pgraph-test-runner` is distributed under the terms of
the [MIT](https://spdx.org/licenses/MIT.html) license.

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "nxdk-pgraph-test-runner",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "nv2a, pgraph, xbox, xemu",
    "author": null,
    "author_email": "Erik Abair <erik.abair@bearbrains.work>",
    "download_url": "https://files.pythonhosted.org/packages/80/d1/d2d0c4e6c254db104775b0c251b6e215431f1eb559c57bbe5c9e76721606/nxdk_pgraph_test_runner-0.1.17.tar.gz",
    "platform": null,
    "description": "# nxdk-pgraph-test-runner\n\n[![PyPI - Version](https://img.shields.io/pypi/v/nxdk-pgraph-test-runner.svg)](https://pypi.org/project/nxdk-pgraph-test-runner)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/nxdk-pgraph-test-runner.svg)](https://pypi.org/project/nxdk-pgraph-test-runner)\n\n-----\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Configuration](#configuration)\n- [License](#license)\n\n## Purpose\n\nThis test harness utilizes\nthe [nxdk_pgraph_tests](https://github.com/abaire/nxdk_pgraph_tests) project to\nexercise the NV2A 3D accelerator on the original Microsoft Xbox. The runner is\nintended to be used with an emulator (e.g., [xemu](https://xemu.app)) and is\nable to detect and recover from crashes.\n\n## Installation\n\n### Prerequisites\n\n* An xbox emulator (e.g., [xemu](https://xemu.app)) - required\n\n### pip installation\n\n```console\n# Optionally create a virtual env\n#   pip -m venv .venv\n#   source .venv/bin/activate\n\npip install nxdk-pgraph-test-runner\n\nnxdk-pgraph-test-runner --help\n```\n\n## Configuration\n\nA default config may be generated by running the `nxdk-pgraph-test-runner`\ncommand.\n\n### Emulator command line\n\n`\"emulator_command = /path/to/emulator {ISO}\"`\n\nThe command may utilize the following macros:\n\n* `{ISO}` - Replaced with the path to the `nxdk_pgraph_tests.iso` xiso file.\n\n### Example invocation\n\nThis is a sample invocation that will run xemu against a previously downloaded\nnxdk_pgraph_tests iso. It will create a `results` directory with the results of\nthe tests.\n\n```shell\nnxdk-pgraph-test-runner \\\n    --override-ftp-ip 10.0.2.2 \\\n    --iso-path ~/nxdk_pgraph_tests_xiso.iso \\\n    --emulator-command \"/path/to/xemu -dvd_path \\\"{ISO}\\\"\" \\\n    -I lo0\n```\n\nThis assumes that xemu is configured to use NAT networking, so the IP reported\nto the pgraph tester is set to the qemu `10.0.2.2` host address and the loopback\ninterface (-I `lo0`) is used.\n\n## License\n\n`nxdk-pgraph-test-runner` is distributed under the terms of\nthe [MIT](https://spdx.org/licenses/MIT.html) license.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Executes and captures the results of https://github.com/abaire/nxdk_pgraph_tests in an emulator",
    "version": "0.1.17",
    "project_urls": {
        "Documentation": "https://github.com/abaire/nxdk-pgraph-test-runner#readme",
        "Issues": "https://github.com/abaire/nxdk-pgraph-test-runner/issues",
        "Source": "https://github.com/abaire/nxdk-pgraph-test-runner"
    },
    "split_keywords": [
        "nv2a",
        " pgraph",
        " xbox",
        " xemu"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "5e4866246b41e05ca3ef322dc2e5ec7909d9c3d9802158f99e87819b3665e80d",
                "md5": "4264758ad1d6e32a1f13e9f55a906c78",
                "sha256": "459a63ccf98b81a2daa2109389721028ec221a3d7350c95f8c216255115d822c"
            },
            "downloads": -1,
            "filename": "nxdk_pgraph_test_runner-0.1.17-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4264758ad1d6e32a1f13e9f55a906c78",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 19978,
            "upload_time": "2025-07-08T22:09:33",
            "upload_time_iso_8601": "2025-07-08T22:09:33.240818Z",
            "url": "https://files.pythonhosted.org/packages/5e/48/66246b41e05ca3ef322dc2e5ec7909d9c3d9802158f99e87819b3665e80d/nxdk_pgraph_test_runner-0.1.17-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "80d1d2d0c4e6c254db104775b0c251b6e215431f1eb559c57bbe5c9e76721606",
                "md5": "1906e51be8fcca6ab0246802ed193a5e",
                "sha256": "f4eae444636549d0fd8cb98a1d58c99e8e7a833f92218f307e1686ec744a5ec7"
            },
            "downloads": -1,
            "filename": "nxdk_pgraph_test_runner-0.1.17.tar.gz",
            "has_sig": false,
            "md5_digest": "1906e51be8fcca6ab0246802ed193a5e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 17358,
            "upload_time": "2025-07-08T22:09:34",
            "upload_time_iso_8601": "2025-07-08T22:09:34.312187Z",
            "url": "https://files.pythonhosted.org/packages/80/d1/d2d0c4e6c254db104775b0c251b6e215431f1eb559c57bbe5c9e76721606/nxdk_pgraph_test_runner-0.1.17.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-08 22:09:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "abaire",
    "github_project": "nxdk-pgraph-test-runner#readme",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "nxdk-pgraph-test-runner"
}
None
Elapsed time: 1.68166s