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.9.0.tar.gz (42.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.9.0-py3-none-any.whl (50.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: usdm4_m11-0.9.0.tar.gz
  • Upload date:
  • Size: 42.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.9.0.tar.gz
Algorithm Hash digest
SHA256 26aa385459dfc9e9d41955798cb43bc687b90fb68efc91c88c917d5299a8d33f
MD5 ff9a271578178cbdfa5ba3e073ee3f75
BLAKE2b-256 6fe7f51aa49728d3008875d115438585fc4e7cf3802494836f1e0223d8f11dc5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: usdm4_m11-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 50.4 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.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0abcb73bb34ab6d75410a9b74f7a2494a7c497b6cfbaa14ce6afc293e34d2422
MD5 e2b6d480c3697610b300566b5363e35f
BLAKE2b-256 f398be6ecc339418fe36f470a16d8f2d1d2ae1907476b0e342a50230778d89dc

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