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.6.1.tar.gz (25.4 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.6.1-py3-none-any.whl (30.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: usdm4_m11-0.6.1.tar.gz
  • Upload date:
  • Size: 25.4 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.6.1.tar.gz
Algorithm Hash digest
SHA256 ebb8269d973c10f9b124505efec0165f6b8e4a642e6e0fadeba158ed15103b6c
MD5 38aea9dab2d3b28eee9270e2e4903dad
BLAKE2b-256 7b4b840239212e95f046ed19c4541032df8043df0239106ecbc366d745e53004

See more details on using hashes here.

File details

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

File metadata

  • Download URL: usdm4_m11-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 30.1 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.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2542e31b7c707d0e2900ad9952037e07e1c08b7de17aed2d0f885bf0ed2364ef
MD5 d6704ed5ce4c43767b5299b70f43d621
BLAKE2b-256 257b055c329a6213591bd3337b4c7c4eebf189dfaae70a0c28f3346aa8c3b374

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