GramPy

GramPy is an importable Python library and command-line tooling for decoding MFSK32 and MFSK64 transmissions from SigMF IQ recordings. It is maintained as a standalone project after its extraction from Radiogram.

The PyPI distribution name is radiogrampy; its Python import name is grampy.

Python 3.11 or newer is required.

Setup

Create a virtual environment and install GramPy with its runtime dependencies:

python3 -m venv .venv
.venv/bin/python -m pip install --editable . pillow

Pillow is used by the image-related test suite. The repository uses a src/ layout, so run Python work with both the virtual environment and source tree selected:

PYTHONPATH="$PWD/src" PATH="$PWD/.venv/bin:$PATH" \
  .venv/bin/python -m unittest discover -s tests

For full-suite runs, experiments, corpus jobs, or other potentially long work, follow the managed-execution contract in AGENTS.md. The normal Mac entry point is tools/mac-local.sh; place a temporary command batch in the ignored .local/mac-command.sh when needed.

Tests and corpus

The normal regression suite runs without large external artifacts. Tests that need received IQ or controlled generated fixtures skip cleanly when those optional inputs are absent.

See tests/README.md to install an optional received-IQ corpus, point tests at an existing corpus, or package one for controlled distribution. Large samples are never committed to this repository.

Decode a SigMF recording

GramPy includes a command-line adapter for reproducible decoder work on a SigMF metadata/data pair:

tools/mfsk-iq-decode \
  --in-meta recording.sigmf-meta \
  --in-data recording.sigmf-data \
  --out-manifest results/decode.json \
  --mode MFSK64

The command writes a manifest containing the decoded text, diagnostics, and artifact inventory. Large decoded pictures are written beside it in results/decode.artifacts/; small rasters are embedded in the manifest. See the SigMF decode guide for the accepted metadata, input formats, interval options, and complete output layout.

Development

Use docs/operations/change-management-v1.md for continuous-improvement work. It defines the request, baseline, candidate, evaluation, acceptance, and closeout cycle. Decoder architecture, contracts, validation guidance, and the accepted baseline are indexed in docs/decoder/README.md.

Reusable command-line tools are documented in tools/README.md.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.1.1)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for magixit from gravatar.com magixit

Credits

Author: Sam Elsamman

License expression

MIT
View SPDX License List

Requires

Python >=3.11

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

radiogrampy-0.1.0.tar.gz (163.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

radiogrampy-0.1.0-py3-none-any.whl (130.5 kB view details)

Uploaded Python 3

File details

Details for the file radiogrampy-0.1.0.tar.gz.

File metadata

  • Download URL: radiogrampy-0.1.0.tar.gz
  • Upload date:
  • Size: 163.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for radiogrampy-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a76232a8fc46b20da3cae87edc00511246023e16b60b08cdef5bde24d526b6e9
MD5 fb580b84a4c685f43cbe2737df2e1821
BLAKE2b-256 1ce9eaa12ae44a949bb4931c3065acc835a979083822e33dc8e60b44d858d1c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for radiogrampy-0.1.0.tar.gz:

Publisher: release.yml on selsamman/GramPy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file radiogrampy-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: radiogrampy-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 130.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for radiogrampy-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d5f455602a2e978b0703662cab991bf61d93d5b2792856ca00010b1544fddc58
MD5 f9f7da18282e3c8ac3783406458f1ec6
BLAKE2b-256 20509a8f2de83d6fb101199fdbb324d71136d454d3c1f53553215e588789154a

See more details on using hashes here.

Provenance

The following attestation bundles were made for radiogrampy-0.1.0-py3-none-any.whl:

Publisher: release.yml on selsamman/GramPy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.1.1

2 files

This release

0.1.0 This release

2 files

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