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.4.0.tar.gz (8.6 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.4.0-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: usdm4_m11-0.4.0.tar.gz
  • Upload date:
  • Size: 8.6 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.4.0.tar.gz
Algorithm Hash digest
SHA256 4dceac205d1cbf6034fa2c4d509cacde969f06f197f31ecfbce9f6ff5027f5b5
MD5 0b377ba3542002dc2f1cdd94464347f9
BLAKE2b-256 896da6ad32467c0a21be31bb4981af049ecf0f486d3f61ab277cd3eefb7bb0cb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: usdm4_m11-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 11.1 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7f5a1de8f411a56c9d085caf60755f03f285f9cadd00ec0758405930a7b9d53e
MD5 cd4b05b622e57ecba37eb736a9ea78a1
BLAKE2b-256 99de5e366faaed51d7004880eecbef1d869211b8b882fb1ad176455b774e53e1

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