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.10.0.tar.gz (40.3 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.10.0-py3-none-any.whl (54.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: usdm4_m11-0.10.0.tar.gz
  • Upload date:
  • Size: 40.3 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.10.0.tar.gz
Algorithm Hash digest
SHA256 38bef48f6bf2bbc42c0fba0187bd239beac0fb8c05617c8c5d09db8f8a3dc877
MD5 1a3a45e53163ab8d4b7272c4d436f8a9
BLAKE2b-256 f6e3be15c59d153474cc24ffbc15edefa0a0d877597f8ade8a0f6902c594e99f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: usdm4_m11-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 54.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.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ebfabd8bbdc47b4291a51a77e85edbb5db59f848dcebf18a70b7b18cd3fdabfb
MD5 9c72939d89f9fe19a9d6fe2178215223
BLAKE2b-256 448bb4a29659b60414a64be44fd44986671b69c350fa3606fb3f25cd7f080531

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