Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add setup with pypi to Readme #7

Merged
merged 1 commit into from
Jul 16, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading