add extras to installation

biocypher · Nov 30, 2023 · d99b66f · d99b66f
1 parent 201d64c
commit d99b66f
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -20,4 +20,16 @@ being written [here](https://github.com/biocypher/biochatter-paper).
 To use the package, install it from PyPI, for instance using pip (`pip install
 biochatter`) or Poetry (`poetry add biochatter`).
 
+### Extras
+
+The package has some optional dependencies that can be installed using the
+following extras (e.g. `pip install biochatter[streamlit]`):
+
+- `streamlit`: support for streamlit UI functions (used in ChatGSE)
+
+- `podcast`: support for podcast text-to-speech (for the free Google TTS; the
+paid OpenAI TTS can be used without this extra)
+
+- `xinference`: support for querying open-source LLMs through Xorbits Inference
+
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Python](https://img.shields.io/pypi/pyversions/biochatter)](https://www.python.org) [![PyPI version](https://img.shields.io/pypi/v/biochatter)](https://pypi.org/project/biochatter/) [![Downloads](https://static.pepy.tech/badge/biochatter)](https://pepy.tech/project/biochatter) [![CI](https://github.com/biocypher/biochatter/actions/workflows/ci.yaml/badge.svg)](https://github.com/biocypher/biochatter/actions/workflows/ci.yaml) [![Latest image](https://img.shields.io/docker/v/biocypher/chatgse)](https://hub.docker.com/repository/docker/biocypher/chatgse/general) [![Image size](https://img.shields.io/docker/image-size/biocypher/chatgse/latest)](https://hub.docker.com/repository/docker/biocypher/chatgse/general) [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://black.readthedocs.io/en/stable/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CONTRIBUTING.md)