Metadata-Version: 2.4
Name: eadpy
Version: 0.1.0
Summary: Add your description here
Author-email: Brendan Quinn <brendan-quinn@northwestern.edu>
Requires-Python: >=3.11
Requires-Dist: lxml>=5.3.1
Description-Content-Type: text/markdown

# EADPy

[![Python Versions](https://img.shields.io/pypi/pyversions/eadpy.svg)](https://pypi.org/project/eadpy/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A Python library for working with Encoded Archival Description (EAD) XML documents.

## Features

- Parse and manipulate EAD XML documents
- Convert EAD to various formats (JSON, CSV, etc.)
- Validate EAD documents against schemas
- Tools for batch processing of EAD files

## Installation

Install EADPy using pip:

```bash
pip install eadpy
```

## Usage

```python
from eadpy import Ead

# Load an EAD file and process it
ead = Ead("path/to/finding_aid.xml")
ead.create_and_save_chunks("path/to/output.json")
```

## Development

### Setting up the development environment

EADPy uses [uv](https://github.com/astral-sh/uv) for dependency management and virtual environment setup.

1. Clone the repository:

```bash
git clone https://github.com/yourusername/eadpy.git
cd eadpy
```

2. Create and activate a virtual environment:

```bash
uv venv --python 3.13
source .venv/bin/activate  # On Unix/macOS
# or
.venv\Scripts\activate  # On Windows
```

3. Install development dependencies:

```bash
uv pip install -e ".[dev]"
```

### Running tests

```bash
pytest
```

## Documentation

For full documentation, visit [eadpy.readthedocs.io](https://eadpy.readthedocs.io).

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the MIT License - see the LICENSE file for details.
