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.8.0.tar.gz (28.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.8.0-py3-none-any.whl (49.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: usdm4_m11-0.8.0.tar.gz
  • Upload date:
  • Size: 28.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.8.0.tar.gz
Algorithm Hash digest
SHA256 0249a8615528dc95a8143c95eaa81c62dbd009773ac1c0218df4f794704a3150
MD5 2a42cbbe49909392c60224c13a377648
BLAKE2b-256 f2bc4e588125a3a3b9f9e6b1ce377f809100a7f6d5930d236ee37f322283923c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: usdm4_m11-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 49.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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 be31614467c5f6bfea55b9c3a867641bda0955a279f0af0960786d137333411e
MD5 7c3532b6918950b8f9a538c0a48e8cca
BLAKE2b-256 7170ee00b0e47661a2263d3a075c16c52790e9ae6127415e62bc2c274af0c295

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