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.0.tar.gz (27.7 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.0-py3-none-any.whl (34.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: usdm4_m11-0.7.0.tar.gz
  • Upload date:
  • Size: 27.7 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.0.tar.gz
Algorithm Hash digest
SHA256 7f1ca49fae0292747b8e3328562b988bb6e1afbd58f47f97e91012c6958e8fec
MD5 8c0fe96fee321232bb3231f8077894a9
BLAKE2b-256 0fd866cea75f9468b071586e58c7b094a3d491d91abadef1523e4d653e07578d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: usdm4_m11-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 34.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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7b25e0ce56a351bd4238e41c146ae2805cd8c58aac502815b0208abe1ca94bfe
MD5 53620aa8ec0a1f4af870939614d65ef1
BLAKE2b-256 2c655a806037410755a3712d45d2c5464c904e13315e2d16e2011f2a28b10aef

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