eadpy 0.1.0

Add your description here

EADPy

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:

pip install eadpy

Usage

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 for dependency management and virtual environment setup.

1. Clone the repository:

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

2. Create and activate a virtual environment:

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

3. Install development dependencies:

uv pip install -e ".[dev]"

Running tests

pytest

Documentation

For full documentation, visit 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.