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

Uploaded Python 3

File details

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

File metadata

  • Download URL: usdm4_m11-0.6.0.tar.gz
  • Upload date:
  • Size: 11.5 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.0.tar.gz
Algorithm Hash digest
SHA256 a1e7e8307314056e90b35ac6e4d662a22432dfccd075db20587db04744da06f8
MD5 7cdcba52497eac7a2e7b72575e3b7f50
BLAKE2b-256 509af6911ef84a49e69248b5b3e560d25456f3b3dbaa343de5e83baf69c4b290

See more details on using hashes here.

File details

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

File metadata

  • Download URL: usdm4_m11-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 15.7 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a8e0c158fbcda9341e0106fb2f16db06ff7dd6795bd5ecbd5864da49d42af155
MD5 a6b1f5d94112993ccb26805c3ff57000
BLAKE2b-256 09aa1315641d1e51605eb2cda3233aa8d3a5f8dac7045eb9c391e1bd254469d3

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