Metadata-Version: 2.4
Name: xraygpt
Version: 0.2.4
Summary: Generate kindle-like x-ray for e-books with LLM
Project-URL: homepage, https://github.com/iaalm/xraygpt
Project-URL: repository, https://github.com/iaalm/xraygpt
Project-URL: documentation, https://github.com/iaalm/xraygpt
Author-email: iaalm <iaalmsimon@gmail.com>
License: BSD-3
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.9
Requires-Dist: beautifulsoup4
Requires-Dist: ebooklib
Requires-Dist: langchain
Requires-Dist: langchain-chroma
Requires-Dist: langchain-openai
Requires-Dist: loguru
Provides-Extra: all
Requires-Dist: azure-ai-textanalytics; extra == 'all'
Requires-Dist: azure-core; extra == 'all'
Provides-Extra: azure
Requires-Dist: azure-ai-textanalytics; extra == 'azure'
Requires-Dist: azure-core; extra == 'azure'
Provides-Extra: dev
Requires-Dist: azure-ai-textanalytics; extra == 'dev'
Requires-Dist: azure-core; extra == 'dev'
Requires-Dist: black; extra == 'dev'
Requires-Dist: build; extra == 'dev'
Requires-Dist: hatch; extra == 'dev'
Requires-Dist: isort; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: q; extra == 'dev'
Description-Content-Type: text/markdown

# 🔬📖 X-ray GPT
[![PyPI version](https://badge.fury.io/py/xraygpt.svg)](https://badge.fury.io/py/xraygpt) [![Release Building](https://github.com/iaalm/xraygpt/actions/workflows/release.yml/badge.svg)](https://github.com/iaalm/xraygpt/actions/workflows/release.yml) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) 

Generate kindle-like x-ray for e-books with LLM

## 🚀 Usage

```shell
pip install xraygpt
python -m xraygpt [epub_file]
```

## 🤖 LLM Support

Current this tool only support OpenAI and Azure OpenAI by setting environment variables.

## 🧑‍💻 Dev Setup
```shell
pip install -e '.[dev]'
```

### 🎩 Static analysis
```shell
make format
```
