Skip to main content

USDM4 M11 Protocol Package

A Python package for processing M11 protocol documents and converting them to USDM format.

Installation

pip install -e .

Or install the dependencies directly from the requirements.txt file:

pip install -r requirements.txt

This package uses a src-based layout, with the package code located in the src/usdm4_m11 directory.

Usage

from usdm4_m11 import M11Protocol

# Initialize the protocol processor
protocol = M11Protocol(filepath="path/to/m11_protocol.docx", system_name="YourSystem", system_version="1.0.0")

# Process the protocol
await protocol.process()

# Convert to USDM format
usdm_data = protocol.to_usdm()

Build

Build as a normal package

  • Run pytest, ensure coverage and all tests pass
  • Run ruff format
  • Run ruff check, ensure no errors
  • Build with python3 -m build --sdist --wheel
  • Upload to pypi.org using twine upload dist/*

Metadata

Release files for usdm4-m11 0.10.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 usdm4-m11 0.10.0
File Size Uploaded Provenance Actions
usdm4_m11-0.10.0.tar.gz 40.3 kB Without provenance Details for usdm4_m11-0.10.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for usdm4-m11 0.10.0
File Interpreter ABI Platform Actions
usdm4_m11-0.10.0-py3-none-any.whl Python 3 none any Details for usdm4_m11-0.10.0-py3-none-any.whl

Total release size: 94.2 kB

Release files / usdm4_m11-0.10.0.tar.gz

Download URL usdm4_m11-0.10.0.tar.gz
Size 40.3 kB
Tags Source
SHA-256 checksum
How to use checksums
38bef48f6bf2bbc42c0fba0187bd239beac0fb8c05617c8c5d09db8f8a3dc877
BLAKE2b-256 checksum
How to use checksums
f6e3be15c59d153474cc24ffbc15edefa0a0d877597f8ade8a0f6902c594e99f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Release files / usdm4_m11-0.10.0-py3-none-any.whl

Download URL usdm4_m11-0.10.0-py3-none-any.whl
Size 54.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ebfabd8bbdc47b4291a51a77e85edbb5db59f848dcebf18a70b7b18cd3fdabfb
BLAKE2b-256 checksum
How to use checksums
448bb4a29659b60414a64be44fd44986671b69c350fa3606fb3f25cd7f080531
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Security for usdm4-m11 0.10.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.

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