grobid-client

A client library for accessing Grobid

Usage

First, create a client:

from grobid_client import Client

client = Client(base_url="https://cloud.science-miner.com/grobid/api")

Now call your endpoint and use your models:

from pathlib import Path
from grobid_client.api.pdf import process_fulltext_document
from grobid_client.models import Article, ProcessForm
from grobid_client.types import TEI, File
pdf_file = "MyPDFFile.pdf"
with pdf_file.open("rb") as fin:
    form = ProcessForm(
        segment_sentences="1",
        input_=File(file_name=pdf_file.name, payload=fin, mime_type="application/pdf),
    )
    r = process_fulltext_document.sync_detailed(client=client, multipart_data=form)
    if r.is_success:
        article: Article = TEI.parse(r.content, figures=False)
        assert article.title

Things to know:

1. Every path/method combo becomes a Python module with four functions:

   1. sync: Blocking request that returns parsed data (if successful) or None
   2. sync_detailed: Blocking request that always returns a Request, optionally with parsed set if the request was successful.
   3. asyncio: Like sync but the async instead of blocking
   4. asyncio_detailed: Like sync_detailed by async instead of blocking

2. All path/query params, and bodies become method arguments.

3. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)

4. Any endpoint which did not have a tag will be in entifyfishing_client.api.default

Building / publishing this Client

This project uses Poetry to manage dependencies and packaging. Here are the basics:

1. Update the metadata in pyproject.toml (e.g. authors, version)
2. If you're using a private repository, configure it with Poetry
   1. poetry config repositories.<your-repository-name> <url-to-your-repository>
   2. poetry config http-basic.<your-repository-name> <username> <password>
3. Publish the client with poetry publish --build -r <your-repository-name> or, if for public PyPI, just poetry publish --build

If you want to install this client into another project without publishing it (e.g. for development) then:

1. If that project is using Poetry, you can simply do poetry add <path-to-this-client> from that project
2. If that project is not using Poetry:
   1. Build a wheel with poetry build -f wheel
   2. Install that wheel from the other project pip install <path-to-wheel>