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.1.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.1-py3-none-any.whl (49.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: usdm4_m11-0.8.1.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.1.tar.gz
Algorithm Hash digest
SHA256 af3e3f08c4ec6b3621b8af54eeb90ffee827c2f1a4b460a23c0418bb3fc15eda
MD5 2b7ee0eba05ff09b08978413c9bc17ed
BLAKE2b-256 66410edf2808f04c1ee315fb1158ce4a85a22f402cc63e524001829e0f85376c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: usdm4_m11-0.8.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f6b8783f50ef7eee467b184638571c0fdd2f122dba0c2c847da90249c0e6f723
MD5 4da7d9a0c74f3a9b723891c88deebddf
BLAKE2b-256 b6cfcc6bae29f34bd618a6c2ec8f81c1fbf71a24ec6b5fae0ab9e22625114608

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