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

Uploaded Python 3

File details

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

File metadata

  • Download URL: usdm4_m11-0.5.0.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.0.tar.gz
Algorithm Hash digest
SHA256 e6ec816b38102187503ee87b67cf3c90e8e181fc398d1c282566ac7a29f5e367
MD5 2b507ccbf56baeb7cd80a6bd3fe3c987
BLAKE2b-256 3f29b7991c52a8891fc198c774f73d4684927ffd25d55bb3cfa395b427e570e5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: usdm4_m11-0.5.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a8b5d6c9c46f9b500d866a3b5b702240db5ee048887dca12ec8fe050a50d15aa
MD5 e9e54fc6b114c0410b7c998a07a617ff
BLAKE2b-256 ba66b312de04565f53cc4d645ec1ffe35444978a07c2317be2466cd4638d78dd

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