A client library for accessing Grobid
Project description
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:
-
Every path/method combo becomes a Python module with four functions:
sync
: Blocking request that returns parsed data (if successful) orNone
sync_detailed
: Blocking request that always returns aRequest
, optionally withparsed
set if the request was successful.asyncio
: Likesync
but the async instead of blockingasyncio_detailed
: Likesync_detailed
by async instead of blocking
-
All path/query params, and bodies become method arguments.
-
If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
-
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:
- Update the metadata in pyproject.toml (e.g. authors, version)
- If you're using a private repository, configure it with Poetry
poetry config repositories.<your-repository-name> <url-to-your-repository>
poetry config http-basic.<your-repository-name> <username> <password>
- Publish the client with
poetry publish --build -r <your-repository-name>
or, if for public PyPI, justpoetry publish --build
If you want to install this client into another project without publishing it (e.g. for development) then:
- If that project is using Poetry, you can simply do
poetry add <path-to-this-client>
from that project - If that project is not using Poetry:
- Build a wheel with
poetry build -f wheel
- Install that wheel from the other project
pip install <path-to-wheel>
- Build a wheel with
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for grobid_client-0.8.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a91e8bac3a9b638d426a88f13bd17374bf336a7fa4bd6d5a918550f07fefbe36 |
|
MD5 | 72362928c784b29118c5cbe4a573ed1d |
|
BLAKE2b-256 | d5dfd677331f4cc08c4b4aecde3a0bd88f6d849782c5be36649d733c99d0bad2 |