From 0d5b53de6d36e898a639d813a1dc5aa6b9f04b4a Mon Sep 17 00:00:00 2001 From: Christoph Auer <60343111+cau-git@users.noreply.github.com> Date: Tue, 16 Jul 2024 13:43:53 +0200 Subject: [PATCH] Add setup with pypi to Readme Signed-off-by: Christoph Auer <60343111+cau-git@users.noreply.github.com> --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1367cfd..f70c015 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,19 @@ Docling bundles PDF document conversion to JSON and Markdown in an easy, self-co ## Setup -You need Python 3.11 and poetry. Install poetry from [here](https://python-poetry.org/docs/#installing-with-the-official-installer). +For general usage, you can simply install `docling` through `pip` from the pypi package index. +``` +pip install docling +``` + +**Notes**: +* Works on macOS and Linux environments. Windows platforms are currently not tested. + +### Development setup -Once you have `poetry` installed, create an environment and install the package: +To develop for `docling`, you need Python 3.11 and `poetry`. Install poetry from [here](https://python-poetry.org/docs/#installing-with-the-official-installer). + +Once you have `poetry` installed and cloned this repo, create an environment and install `docling` from the repo root: ```bash poetry env use $(which python3.11) @@ -24,10 +34,6 @@ poetry shell poetry install ``` -**Notes**: -* Works on macOS and Linux environments. Windows platforms are currently not tested. - - ## Usage For basic usage, see the [convert.py](https://github.com/DS4SD/docling/blob/main/examples/convert.py) example module. Run with: