| Name | xemu-perf-tester JSON |
| Version |
0.1.9
JSON |
| download |
| home_page | None |
| Summary | Benchmark orchestrator for the xemu original Microsoft Xbox emulator |
| upload_time | 2025-07-08 22:13:46 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
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 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.
For more information, please refer to <https://unlicense.org> |
| keywords |
xbox
xemu
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
xemu-perf-tester
===
Orchestrates running [xemu](xemu.app) benchmarks
using [xemu-perf-tests](https://github.com/abaire/xemu-perf-tests).
# Installation
Install from [Pypi](https://pypi.org/project/xemu-perf-tester/)
```shell
pip install xemu-perf-tester
```
# Use
## Running benchmarks
Run `xemu-perf-run -h` for detailed information on executing the benchmarks.
One time setup: `xemu-perf-run --import-install <path_to_your_xemu.toml_file>`
### Test the latest xemu with the latest benchmark release
The default behavior is to download the latest xemu-perf-tests iso and xemu
release and run the benchmarks using the OpenGL backend. You may pass the
`--use-vulkan` parameter to use Vulkan instead.
```shell
xemu-perf-run
```
### Testing against specific xemu and/or xemu-perf-tests releases
```shell
xemu-perf-run \
--xemu-tag v0.8.7 \
--test-tag v12345
```
### Reusing existing xemu-perf-tests ISO and/or xemu binary
You can use the `--iso` and `--xemu` flags to specify existing artifacts. This
will skip the automated check against the GitHub API for the `latest` tagged
artifacts.
```shell
xemu-perf-run \
--xemu ~/bin/xemu \
--iso ~/special_perf_tests.xiso
```
#### Using a development build of xemu on macOS
Some extra flags are needed to utilize a development build of xemu. You will
need to set the `DYLD_FALLBACK_LIBRARY_PATH` environment variable to point at a
valid xemu.app binary and will need to pass the `--no-bundle` argument to
`xemu-perf-run` to prevent it from attempting to find a `xemu.app` bundle
itself.
```shell
DYLD_FALLBACK_LIBRARY_PATH=/path/to/xemu_repo/dist/xemu.app/Contents/Libraries/arm64 \
xemu-perf-run \
--xemu /path/to/xemu_repo/build/qemu-system-i386 \
--no-bundle
```
## Test configuration
### Conditional block listing
Tests that cannot be executed on certain versions of xemu may be disallowed
using a `blocklist.json` file specified using the `--block-list-file` command.
The file provides a simple list of JSON objects, each specifying a set of one or
more conditions and one or more test names to be disabled if the
condition is satisfied.
For example, to disable the entire "High vertex count" suite on xemu versions
less than 0.8.54:
```json
{
"rules": [
{
"conditions": [
"$version < 0.8.54"
],
"skipped": [
"High vertex count::"
]
}
]
}
```
"`conditions`" may use the `$version` variable to test against the runtime
reported version of xemu.
"`skipped`" entries are fully qualified test names, with anything before "::"
referring to a test suite and everything after to a specific test. These are
exact matches, so "Suite::Test" will only disable the test literally named "
Suite::Test" but would still allow "Suite::Test1" to run. The trailing "::" may
be omitted when disallowing an entire test suite. For example "Suite::" is
equivalent to "Suite", both will disable all tests in the "Suite" suite.
Raw data
{
"_id": null,
"home_page": null,
"name": "xemu-perf-tester",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "xbox, xemu",
"author": null,
"author_email": "Erik Abair <erik.abair@bearbrains.work>",
"download_url": "https://files.pythonhosted.org/packages/2d/ec/d2bf6792d206995967f96cd7af51dbaa3c368fbec379813d6a1ad4b86a18/xemu_perf_tester-0.1.9.tar.gz",
"platform": null,
"description": "xemu-perf-tester\n===\n\nOrchestrates running [xemu](xemu.app) benchmarks\nusing [xemu-perf-tests](https://github.com/abaire/xemu-perf-tests).\n\n# Installation\n\nInstall from [Pypi](https://pypi.org/project/xemu-perf-tester/)\n\n```shell\npip install xemu-perf-tester\n```\n\n# Use\n\n## Running benchmarks\n\nRun `xemu-perf-run -h` for detailed information on executing the benchmarks.\n\nOne time setup: `xemu-perf-run --import-install <path_to_your_xemu.toml_file>`\n\n### Test the latest xemu with the latest benchmark release\n\nThe default behavior is to download the latest xemu-perf-tests iso and xemu\nrelease and run the benchmarks using the OpenGL backend. You may pass the\n`--use-vulkan` parameter to use Vulkan instead.\n\n```shell\nxemu-perf-run\n```\n\n### Testing against specific xemu and/or xemu-perf-tests releases\n\n```shell\nxemu-perf-run \\\n --xemu-tag v0.8.7 \\\n --test-tag v12345\n```\n\n### Reusing existing xemu-perf-tests ISO and/or xemu binary\n\nYou can use the `--iso` and `--xemu` flags to specify existing artifacts. This\nwill skip the automated check against the GitHub API for the `latest` tagged\nartifacts.\n\n```shell\nxemu-perf-run \\\n --xemu ~/bin/xemu \\\n --iso ~/special_perf_tests.xiso\n```\n\n#### Using a development build of xemu on macOS\n\nSome extra flags are needed to utilize a development build of xemu. You will\nneed to set the `DYLD_FALLBACK_LIBRARY_PATH` environment variable to point at a\nvalid xemu.app binary and will need to pass the `--no-bundle` argument to\n`xemu-perf-run` to prevent it from attempting to find a `xemu.app` bundle\nitself.\n\n```shell\nDYLD_FALLBACK_LIBRARY_PATH=/path/to/xemu_repo/dist/xemu.app/Contents/Libraries/arm64 \\\nxemu-perf-run \\\n --xemu /path/to/xemu_repo/build/qemu-system-i386 \\\n --no-bundle\n```\n\n## Test configuration\n\n### Conditional block listing\n\nTests that cannot be executed on certain versions of xemu may be disallowed\nusing a `blocklist.json` file specified using the `--block-list-file` command.\n\nThe file provides a simple list of JSON objects, each specifying a set of one or\nmore conditions and one or more test names to be disabled if the\ncondition is satisfied.\n\nFor example, to disable the entire \"High vertex count\" suite on xemu versions\nless than 0.8.54:\n\n```json\n{\n \"rules\": [\n {\n \"conditions\": [\n \"$version < 0.8.54\"\n ],\n \"skipped\": [\n \"High vertex count::\"\n ]\n }\n ]\n}\n```\n\n\"`conditions`\" may use the `$version` variable to test against the runtime\nreported version of xemu.\n\n\"`skipped`\" entries are fully qualified test names, with anything before \"::\"\nreferring to a test suite and everything after to a specific test. These are\nexact matches, so \"Suite::Test\" will only disable the test literally named \"\nSuite::Test\" but would still allow \"Suite::Test1\" to run. The trailing \"::\" may\nbe omitted when disallowing an entire test suite. For example \"Suite::\" is\nequivalent to \"Suite\", both will disable all tests in the \"Suite\" suite.\n",
"bugtrack_url": null,
"license": "This is free and unencumbered software released into the public domain.\n \n Anyone is free to copy, modify, publish, use, compile, sell, or\n distribute this software, either in source code form or as a compiled\n binary, for any purpose, commercial or non-commercial, and by any\n means.\n \n In jurisdictions that recognize copyright laws, the author or authors\n of this software dedicate any and all copyright interest in the\n software to the public domain. We make this dedication for the benefit\n of the public at large and to the detriment of our heirs and\n successors. We intend this dedication to be an overt act of\n relinquishment in perpetuity of all present and future rights to this\n software under copyright law.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\n MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\n IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR\n OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,\n ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\n OTHER DEALINGS IN THE SOFTWARE.\n \n For more information, please refer to <https://unlicense.org>",
"summary": "Benchmark orchestrator for the xemu original Microsoft Xbox emulator",
"version": "0.1.9",
"project_urls": {
"Documentation": "https://github.com/abaire/xemu-perf-tester#readme",
"Issues": "https://github.com/abaire/xemu-perf-tester/issues",
"Source": "https://github.com/abaire/xemu-perf-tester"
},
"split_keywords": [
"xbox",
" xemu"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "64b458661ce8504e93162d8b902417359fbf1d68c5eaf05e576075aaafa0d087",
"md5": "5e6ef4d506270133f2107f10247da19f",
"sha256": "7f7dc82457c68e955c6db052394f300131e866ef7d598a6652773ee3191716d9"
},
"downloads": -1,
"filename": "xemu_perf_tester-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e6ef4d506270133f2107f10247da19f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 17970,
"upload_time": "2025-07-08T22:13:44",
"upload_time_iso_8601": "2025-07-08T22:13:44.934826Z",
"url": "https://files.pythonhosted.org/packages/64/b4/58661ce8504e93162d8b902417359fbf1d68c5eaf05e576075aaafa0d087/xemu_perf_tester-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2decd2bf6792d206995967f96cd7af51dbaa3c368fbec379813d6a1ad4b86a18",
"md5": "118ff6c609a89568336900665e252c1a",
"sha256": "57b79fb7832f667c57063417d275381476a35e26bc7aa4f5697bafd1afc28dd7"
},
"downloads": -1,
"filename": "xemu_perf_tester-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "118ff6c609a89568336900665e252c1a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 3714,
"upload_time": "2025-07-08T22:13:46",
"upload_time_iso_8601": "2025-07-08T22:13:46.175946Z",
"url": "https://files.pythonhosted.org/packages/2d/ec/d2bf6792d206995967f96cd7af51dbaa3c368fbec379813d6a1ad4b86a18/xemu_perf_tester-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-08 22:13:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "abaire",
"github_project": "xemu-perf-tester#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "xemu-perf-tester"
}
