Skip to content

Commit

Permalink
docs: Add setup with pypi to Readme (#7)
Browse files Browse the repository at this point in the history
Signed-off-by: Christoph Auer <60343111+cau-git@users.noreply.github.com>
Signed-off-by: Christoph Auer <cau@zurich.ibm.com>
  • Loading branch information
cau-git committed Jul 17, 2024
1 parent e467485 commit f3d6557
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,26 @@ 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)
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:
Expand Down

0 comments on commit f3d6557

Please sign in to comment.