Skip to main content

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

Project description

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/*

Project details


Download files

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

Source Distribution

usdm4_m11-0.7.2.tar.gz (28.1 kB view details)

Uploaded Source

Built Distribution

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

usdm4_m11-0.7.2-py3-none-any.whl (35.0 kB view details)

Uploaded Python 3

File details

Details for the file usdm4_m11-0.7.2.tar.gz.

File metadata

  • Download URL: usdm4_m11-0.7.2.tar.gz
  • Upload date:
  • Size: 28.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for usdm4_m11-0.7.2.tar.gz
Algorithm Hash digest
SHA256 5376a268829b0217ab38a03f47b61e863ddf2832705457c1ac891d9e0ca62fbd
MD5 85198e105b624a893394854e26a84e87
BLAKE2b-256 db70138d824645837a79a175bc7caf947680578593d0c86d0ecae26450d0bafc

See more details on using hashes here.

File details

Details for the file usdm4_m11-0.7.2-py3-none-any.whl.

File metadata

  • Download URL: usdm4_m11-0.7.2-py3-none-any.whl
  • Upload date:
  • Size: 35.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for usdm4_m11-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c539beb2917b2a5876eb5ac10aa1f0e534c64d9e1948b7d4b0e082be6ceb4a82
MD5 b61c4a33f4548c69386e0cd2ea2ab223
BLAKE2b-256 4b3a1c044d67939c38cd2b23bb5549df512923fba35e0aaab1d513dfba44ed79

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page