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.1.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.1-py3-none-any.whl (35.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: usdm4_m11-0.7.1.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.1.tar.gz
Algorithm Hash digest
SHA256 9aca1015b3d1d67d9674697178b9384e3f91dd89a68f4b3e2b5a0e5f9501e276
MD5 6dd36b2e8859a322f21681e126d6cbad
BLAKE2b-256 a90957357b1519a64f666246ba25fea600214d015f25f49f2fc78eca1d63d7e3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: usdm4_m11-0.7.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ae3f7cf5930568c22ca571099dde05fb25bd896ddc2a7dce01b6d8971b8e2f75
MD5 869e2b2f61b7052c88fb58078c9eaf70
BLAKE2b-256 91703dcf901471db5276194cfaed843fd25f00d1d6b17cf786d69edb7115ff37

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