yujunjun/docling
1
0
Fork 0
mirror of https://github.com/docling-project/docling.git synced 2025-06-27 05:20:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add setup with pypi to Readme (#7)

Browse Source 
Signed-off-by: Christoph Auer <60343111+cau-git@users.noreply.github.com>
This commit is contained in:
Christoph Auer 2024-07-16 14:15:09 +02:00 committed by GitHub
parent 5c88574d03
commit 2803222ee1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -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
```
Once you have `poetry` installed, create an environment and install the package:
**Notes**:
* Works on macOS and Linux environments. Windows platforms are currently not tested.
### Development setup
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: