eadpy 0.1.0__tar.gz

eadpy-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+.vscode/
+*.DS_Store
+.coverage
+htmlcov/

eadpy-0.1.0/.python-version

@@ -0,0 +1 @@
+3.11

eadpy-0.1.0/PKG-INFO

@@ -0,0 +1,86 @@
+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.

eadpy-0.1.0/README.md

@@ -0,0 +1,77 @@
+# 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.

eadpy-0.1.0/pyproject.toml

@@ -0,0 +1,25 @@
+[project]
+name = "eadpy"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+authors = [
+    { name = "Brendan Quinn", email = "brendan-quinn@northwestern.edu" }
+]
+requires-python = ">=3.11"
+dependencies = [
+    "lxml>=5.3.1",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.3.5",
+    "pytest-cov>=6.0.0",
+]
+
+[project.scripts]
+eadpy = "eadpy.cli:main"

eadpy-0.1.0/pytest.ini

@@ -0,0 +1,4 @@
+[pytest]
+addopts = -v
+testpaths = tests
+python_files = test_*.py

eadpy-0.1.0/src/eadpy/__init__.py

@@ -0,0 +1,8 @@
+"""
+EADPy - A Python library for parsing EAD (Encoded Archival Description) XML files.
+"""
+
+from eadpy.ead import Ead
+
+__version__ = "0.1.0"
+__all__ = ["Ead"]

eadpy-0.1.0/src/eadpy/cli.py

@@ -0,0 +1,46 @@
+"""
+Command-line interface for the EADPy library.
+"""
+import sys
+import os
+from eadpy import Ead
+
+def main():
+    """Main entry point for the EADPy command-line interface."""
+    if len(sys.argv) < 2:
+        print("Usage: eadpy path_to_ead.xml [output_file.json]")
+        sys.exit(1)
+    
+    ead_file = sys.argv[1]
+    print(f"Loading EAD file: {ead_file}")
+    
+    try:
+        if not os.path.exists(ead_file):
+            print(f"Error: File '{ead_file}' does not exist.")
+            print(f"Current working directory: {os.getcwd()}")
+            sys.exit(1)
+            
+        ead = Ead(ead_file)
+        print(f"Successfully parsed EAD file: {ead_file}")
+
+        output_file = None
+        if len(sys.argv) == 3:
+            output_file = sys.argv[2]
+            print(f"Output file: {output_file}")
+        else:
+            print("No output file specified. Using default: ead.json")
+            output_file = "ead.json"
+        
+        ead.create_and_save_chunks(output_file)
+        print(f"Successfully wrote output to: {output_file}")
+        
+    except FileNotFoundError as e:
+        print(f"Error: {str(e)}")
+        print(f"Current working directory: {os.getcwd()}")
+        sys.exit(1)
+    except Exception as e:
+        print(f"Error: {str(e)}")
+        sys.exit(1)
+
+if __name__ == "__main__":
+    main()