Skip to main content

OakEmu-Python

Build Status PyPI - Version PyPI - Downloads

Python wrappers for the OakEmu project.

Documentation · Python API

Local development

Use Python 3.13–3.15, uv and the .NET 10 runtime.

uv sync --locked
uv run coverage run --branch --source=src,scripts --m pytest --junitxml=test-results.xml
uv run ruff check
uv run ruff format --check
uv run ty check

Preview documentation

With uv and Docker installed, run python3 docs/preview.py, or select Preview documentation in a JetBrains IDE. Open http://localhost:5173/OakEmu-Python/. Restart the preview after editing source or documentation. The API is generated statically from Python source; previewing it does not load .NET. Generated output under artifacts/ is ignored.

Releases

Build and Test validates Python 3.13, 3.14 and 3.15, with documentation validated on Python 3.14. Release builds and tests before publishing packages and documentation. Either publication can be disabled; turn packages off to update documentation without uploading another PyPI version. No release tag is created for a docs-only run. A blank release version increments the latest stable Git tag's minor version, starting from 0.0.0 before the first tagged release. For the first docs-only deployment after this port, set api-ref to main: the historical v0.0.45 source predates the corrected public exports and API docstrings. After the next package release, leave it blank.

The package version is derived from Git tags using hatch-vcs; there is no fixed version to update in pyproject.toml. Local builds between releases receive a development version. Release builds use the workflow-selected version.

Configure GitHub Pages to use GitHub Actions. For package publication, configure a PyPI Trusted Publisher for this repository, workflow release.yml and environment github-pages; no long-lived PYPI_API_KEY is used.

Update emulator assemblies

Run uv run python scripts/update_assemblies.py to build the sibling OakEmu checkout in Release mode and copy its referenced runtime dependencies. Formatting stays for HTML dumps; optional VYaml configuration APIs and unrelated build tooling are omitted. The script removes JetBrains annotations and replaces the old bundle, including dependencies that have been removed or renamed. Dependency versions come from OakEmu's central NuGet configuration; there are no separate version numbers to maintain here.

Run the tests before releasing the refreshed package. Projects such as OakEmu-RL that bundle additional assemblies must use the corresponding OakEmu-Python release.

Metadata

Release files for mrkwatkins-oakemu 0.0.47

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mrkwatkins-oakemu 0.0.47
File Size Uploaded Provenance
mrkwatkins_oakemu-0.0.47.tar.gz 697.4 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for mrkwatkins-oakemu 0.0.47
File Interpreter ABI Platform
mrkwatkins_oakemu-0.0.47-py3-none-any.whl Python 3 none any Details

Total release size: 1.4 MB

Release files / mrkwatkins_oakemu-0.0.47.tar.gz

Download URL mrkwatkins_oakemu-0.0.47.tar.gz
Size 697.4 kB
Tags Source
SHA-256 checksum
How to use checksums
4c7fcaab2eab951bd2e24099f0ef0d28cd813679c7833b7ebddbeff0ef95a513
BLAKE2b-256 checksum
How to use checksums
8ea09e551385c9ec8e62738a1545fb3da16267c98ee2d817a59db6a8c4224905
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / mrkwatkins_oakemu-0.0.47-py3-none-any.whl

Download URL mrkwatkins_oakemu-0.0.47-py3-none-any.whl
Size 707.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
af87eef4f93216eab42afa6c24d51e21c7a8eb22554659ee89315757ebe53b0f
BLAKE2b-256 checksum
How to use checksums
5c0ced8bdc571da7ff2846a2e6eff3faa98b0bb62c3db88448635f00151ed94f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for mrkwatkins-oakemu 0.0.47

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.47 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page