Metadata-Version: 2.4
Name: usdm4_m11
Version: 0.7.0
Summary: A package for processing M11 protocol documents and converting them to USDM format
Author: D Iberson-Hurst
Author-email: 
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: usdm4>=0.11.0
Requires-Dist: raw_docx>=0.10.0
Requires-Dist: usdm4_cpt>=0.3.0
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# USDM4 M11 Protocol Package

A Python package for processing M11 protocol documents and converting them to USDM format.

## Installation

```bash
pip install -e .
```

Or install the dependencies directly from the requirements.txt file:

```bash
pip install -r requirements.txt
```

This package uses a src-based layout, with the package code located in the `src/usdm4_m11` directory.

## Usage

```python
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/*`
