Metadata-Version: 2.5
Name: biblealignlib
Version: 0.4.2
Summary: Code for managing Word-level alignments for Bibles, including both automatic alignments and manually corrected alignments.
Project-URL: Repository, https://github.com/Clear-Bible/biblealignlib
Author-email: Sean Boisen <sean.boisen@biblica.com>
License-Expression: MIT
License-File: LICENSE
License-File: LICENSE.md
Keywords: Bible,Bible alignment,alignment
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Religion
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Religion
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: <3.14,>=3.11
Requires-Dist: altair<6.0.0,>=5.5.0
Requires-Dist: biblelib<0.6.0,>=0.5.3
Requires-Dist: jupyterlab<5.0.0,>=4.3.3
Requires-Dist: pandas<4.0.0,>=3.0.3
Requires-Dist: python-dotenv<2.0.0,>=1.0.1
Requires-Dist: regex<2025.0.0,>=2024.11.6
Requires-Dist: unicodecsv<0.15.0,>=0.14.1
Description-Content-Type: text/markdown

# biblealignlib

Biblica's Python code for working with Bible alignment data from
https://github.com/Clear-Bible/Alignments .

This code is ©2024-2026 by [Biblica, Inc](http://biblica.com) and is
licensed under [CC BY SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).


## Installing

Requires Python 3.11–3.13.

To use the library in another project:

```
pip install biblealignlib   # or: uv add biblealignlib
```

### Development

This project uses [uv](https://docs.astral.sh/uv/) for dependency and
environment management (it replaced Poetry as of version 0.4.1).

```
uv sync                # install runtime + dev dependencies
uv sync --group docs   # additionally install documentation dependencies
```

Common commands (run inside the project root):

```
uv run pytest          # run the test suite
uv run mypy            # run type checks
uv run mkdocs serve    # preview the docs locally
uv run jupyter lab     # run the tutorial notebooks
```

## Configuration

biblealignlib locates alignment data relative to a `CLEARROOT`
directory containing local clones of the Clear-Bible repositories
(`Alignments`, `alignments-eng`, etc.). Set it in a `.env` file in
your working directory, or as an environment variable:

```
CLEARROOT=/path/to/Clear-Bible
```

If not set, it defaults to `~/git/Clear-Bible`.

## Documentation

See [docs/index.md](docs/index.md) for tutorials, how-to guides,
explanations, and API reference, and
[docs/ReleaseNotes.md](docs/ReleaseNotes.md) for the change history.

## Installing extra dependencies

### eflomal

`eflomal` is a tool for automated alignment. It is not installed by
default because it requires a custom build.

On macOS, you may need to install additional dependencies before installing:

```
brew install llvm libomp
```

You'll need to override the `CFLAGS` and `LDFLAGS` environment variables before installing `eflomal`:

```
export CFLAGS="-Xpreprocessor -fopenmp -I${HOMEBREW_PREFIX}/opt/libomp/include -Ofast -march=native -Wall --std=gnu99 -Wno-unused-function -g"
export LDFLAGS="-Xpreprocessor -fopenmp -L${HOMEBREW_PREFIX}/opt/libomp/lib -lm -lomp"
uv pip install eflomal
```

