Metadata-Version: 2.4
Name: elijah
Version: 0.1.0
Summary: An Agentic Workbench for Family History Research
Project-URL: Homepage, https://github.com/DecisionNerd/elijah
Project-URL: Repository, https://github.com/DecisionNerd/elijah
Project-URL: Issues, https://github.com/DecisionNerd/elijah/issues
Author-email: David Spencer <DecisionNerd@users.noreply.github.com>
License: MIT
License-File: LICENSE
Keywords: agentic,ai,family-history,genealogy,research
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Sociology :: Genealogy
Requires-Python: >=3.13
Provides-Extra: dev
Requires-Dist: hypothesis>=6.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
Requires-Dist: pytest-mock>=3.0; extra == 'dev'
Requires-Dist: pytest-timeout>=2.0; extra == 'dev'
Requires-Dist: pytest-xdist>=3.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-autorefs>=1.0.0; extra == 'docs'
Requires-Dist: mkdocs-material>=9.5.0; extra == 'docs'
Requires-Dist: mkdocs>=1.6.0; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.24.0; extra == 'docs'
Description-Content-Type: text/markdown

# Elijah

An Agentic Workbench for Family History Research

## Overview

Elijah is an AI-powered workbench designed to assist with family history and genealogical research. It leverages agentic AI capabilities to help researchers organize, analyze, and discover insights in their family history data.

## Features

- Coming soon

## Installation

### From PyPI

```bash
pip install elijah
```

### From Source

```bash
git clone https://github.com/DecisionNerd/elijah.git
cd elijah
pip install -e .
```

## Usage

After installation, you can run Elijah using the command line:

```bash
elijah
```

Or use it as a Python module:

```python
from elijah import main

main()
```

## Development

### Setup Development Environment

```bash
# Clone the repository
git clone https://github.com/DecisionNerd/elijah.git
cd elijah

# Create a virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install development dependencies
pip install -e ".[dev]"
```

### Running Tests

```bash
pytest
```

### Code Quality

```bash
# Run linting
ruff check .

# Run formatting
ruff format .

# Run type checking
mypy src/elijah
```

## Requirements

- Python 3.13 or higher

## Contributing

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

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Project Status

Elijah is currently in early development (Alpha stage). APIs and features may change significantly between versions.

## Acknowledgments

Named after the prophet Elijah, who in Jewish tradition is said to attend every brit milah and Passover Seder, symbolizing the connection between generations and the importance of family legacy.
