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

Uploaded Python 3

File details

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

File metadata

  • Download URL: usdm4_m11-0.5.1.tar.gz
  • Upload date:
  • Size: 10.0 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.5.1.tar.gz
Algorithm Hash digest
SHA256 f8c7877431b3e1d7e099360e63c127623523240073664b7924d6882c14c079d9
MD5 8ec938040cd2639cd9b0ca0d69d1e333
BLAKE2b-256 aeb486b8c3c8d59df2f61f8d6e42339eb3ecbf1291264d92f51507720aa8228c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: usdm4_m11-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 26.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.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ebb7563b625f52c102ea6b3b69ad0580789c95925e60d4d894bb9db53de73a4f
MD5 b09dd1054d17f473a01b539da1efeecb
BLAKE2b-256 c3567f13692e7347aec1f533cfad74323ba869fcef6b5166a5ed3ab7c345ea19

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