Skip to main content

oaknut-hfe

PyPI version CI Python versions License: MIT

HFE (HxC Floppy Emulator) disc-image support for the oaknut family of packages.

An HFE file records each track of a floppy disc as the raw bitstream the drive head delivers. It is the native format of the HxC and Gotek floppy emulators and a common output of preservation capture hardware such as the Greaseweazle. Because it sits below the sector level, an HFE image keeps everything an original disc carries, including the non-standard sector IDs, deliberate CRC errors, deleted-data marks and extra tracks that copy protection relies on.

This package reads HFE v1 and v3 images, decodes their FM and MFM tracks into sectors, and flattens a decoded disc into the logical sector image that the oaknut filesystems read.

Usage

Every disc command that reads an image opens an HFE file as the sector image decoded from it:

disc ls 'Dunjunz_D1S1.hfe:$'
disc export Dunjunz_D1S1.hfe dunjunz/

The disc hfe commands look below the sector level:

disc hfe info Dunjunz_D1S1.hfe                 # header and decoded layout
disc hfe sectors --anomalies Dunjunz_D1S1.hfe  # what protection put there
disc hfe flatten Dunjunz_D1S1.hfe Dunjunz_D1S1.ssd

From Python:

from oaknut.hfe import HFEImage, analyse, decode_image, flatten

disc = decode_image(HFEImage.from_filepath("Dunjunz_D1S1.hfe"))
flat = flatten(disc)  # flat.data is the .ssd image
for finding in analyse(disc, flat.layout):
    if finding.anomalous:
        print(finding.track, finding.side, finding.remarks)

Status

Pre-alpha, read-only.

Installation

uv add oaknut-hfe

License

MIT — see LICENSE.

Metadata

Release files for oaknut-hfe 13.6.0

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

Source distribution (sdist)

Source distribution for oaknut-hfe 13.6.0
File Size Uploaded Provenance Actions
oaknut_hfe-13.6.0.tar.gz 29.7 kB Without provenance Details for oaknut_hfe-13.6.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for oaknut-hfe 13.6.0
File Interpreter ABI Platform Actions
oaknut_hfe-13.6.0-py3-none-any.whl Python 3 none any Details for oaknut_hfe-13.6.0-py3-none-any.whl

Total release size: 55.0 kB

Release files / oaknut_hfe-13.6.0.tar.gz

Download URL oaknut_hfe-13.6.0.tar.gz
Size 29.7 kB
Tags Source
SHA-256 checksum
How to use checksums
2cc371da4ecf1f4a843424e8b94cea1d7279ecbf6713c6e8f140616cd4856599
BLAKE2b-256 checksum
How to use checksums
2809dc9c69297da0cabd638357aba020244b4c90ad786fbfc471fdd420e4edf7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / oaknut_hfe-13.6.0-py3-none-any.whl

Download URL oaknut_hfe-13.6.0-py3-none-any.whl
Size 25.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7ef9eaba8c6602e7fb2dab0d3671f0a5c9b7ce4a4769ad01c99fd0029ca11c59
BLAKE2b-256 checksum
How to use checksums
c486867c9eabf8d7ee5321ef26c8a4baa5c86a6078f42559313cdb5fff8e93ec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for oaknut-hfe 13.6.0

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

13.6.0 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