grobid-client-python 0.0.11__tar.gz → 0.0.13__tar.gz

{grobid_client_python-0.0.11 → grobid_client_python-0.0.13}/.github/workflows/ci-build.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install --upgrade flake8 pytest pycodestyle pytest-cov
+          pip install --upgrade flake8 pytest pycodestyle pytest-cov pytest-mock
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
       - name: Lint with flake8
         run: |
@@ -34,6 +34,14 @@ jobs:
           flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
           # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
           flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-#      - name: Test with pytest
-#        run: |
-#          pytest
+      - name: Test with pytest
+        run: |
+          pytest tests/ -v --cov=grobid_client --cov-report=xml --cov-report=term-missing
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.11'
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false

{grobid_client_python-0.0.11 → grobid_client_python-0.0.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: grobid-client-python
-Version: 0.0.11
+Version: 0.0.13
 Summary: Simple python client for GROBID REST services
 Author-email: Patrice Lopez <patrice.lopez@science-miner.com>
 Maintainer-email: Patrice Lopez <patrice.lopez@science-miner.com>, Luca Foppiano <lucanoro@duck.com>
@@ -218,15 +218,12 @@ Requires-Dist: requests
 [![SWH](https://archive.softwareheritage.org/badge/origin/https://github.com/kermitt2/grobid_client_python/)](https://archive.softwareheritage.org/browse/origin/https://github.com/kermitt2/grobid_client_python/)
 [![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
 
-# Simple python client for GROBID REST services
+# Simple Python client for GROBID REST services
 
 This Python client can be used to process in an efficient concurrent manner a set of PDF in a given directory by the [GROBID](https://github.com/kermitt2/grobid) service. It includes a command line for processing PDF on a file system and write results in a given output directory and a library for import in other python scripts. The client can also process similarly a list of files with reference strings (one per line) and patents in XML ST36 formats.
 
-## Before you start
-
-Please be aware that, at the moment, [grobid does not support Windows](https://grobid.readthedocs.io/en/latest/Troubleshooting/#windows-related-issues).
-If you are a Windows user, don't worry. You can still [run grobid 
-via Docker](https://grobid.readthedocs.io/en/latest/Grobid-docker/).
+> [!IMPORTANT]
+> Please be aware that, at the moment, Grobid supports windows only through Docker containers. See [here](https://grobid.readthedocs.io/en/latest/Grobid-docker/).
 
 ## Build and run
 
@@ -274,7 +271,7 @@ usage: grobid_client [-h] [--input INPUT] [--output OUTPUT] [--config CONFIG]
                      [--n N] [--generateIDs] [--consolidate_header]
                      [--consolidate_citations] [--include_raw_citations]
                      [--include_raw_affiliations] [--force] [--teiCoordinates]
-                     [--verbose]
+                     [--verbose] [--flavor FLAVOR]
                      service
 
 Client for GROBID services
@@ -313,9 +310,13 @@ optional arguments:
   --segmentSentences    segment sentences in the text content of the document
                         with additional <s> elements
   --verbose             print information about processed files in the console
+  --flavor              specifcy the flavor to be used. Current accepted
+                        values: `article/light`, `article/light-ref`, `sdo/ietf`.
+```
 
+> [!TIP]
+> Before using flavors, check [here](https://grobid.readthedocs.io/en/latest/Grobid-specialized-processes/#flavors).
 
-```
 
 Examples:
 
@@ -364,6 +365,9 @@ See also `example.py`.
 
 ## Configuration of the client
 
+> [!TIP]
+> from version 0.0.12 the `config.json` will be optional, by default the client will connect to the local server. 
+
 There are a few parameters that can be set with the `config.json` file. 
 
 - `grobid_server` indicates the URL of the GROBID server to be used by the client. 

{grobid_client_python-0.0.11 → grobid_client_python-0.0.13}/Readme.md

@@ -2,15 +2,12 @@
 [![SWH](https://archive.softwareheritage.org/badge/origin/https://github.com/kermitt2/grobid_client_python/)](https://archive.softwareheritage.org/browse/origin/https://github.com/kermitt2/grobid_client_python/)
 [![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
 
-# Simple python client for GROBID REST services
+# Simple Python client for GROBID REST services
 
 This Python client can be used to process in an efficient concurrent manner a set of PDF in a given directory by the [GROBID](https://github.com/kermitt2/grobid) service. It includes a command line for processing PDF on a file system and write results in a given output directory and a library for import in other python scripts. The client can also process similarly a list of files with reference strings (one per line) and patents in XML ST36 formats.
 
-## Before you start
-
-Please be aware that, at the moment, [grobid does not support Windows](https://grobid.readthedocs.io/en/latest/Troubleshooting/#windows-related-issues).
-If you are a Windows user, don't worry. You can still [run grobid 
-via Docker](https://grobid.readthedocs.io/en/latest/Grobid-docker/).
+> [!IMPORTANT]
+> Please be aware that, at the moment, Grobid supports windows only through Docker containers. See [here](https://grobid.readthedocs.io/en/latest/Grobid-docker/).
 
 ## Build and run
 
@@ -58,7 +55,7 @@ usage: grobid_client [-h] [--input INPUT] [--output OUTPUT] [--config CONFIG]
                      [--n N] [--generateIDs] [--consolidate_header]
                      [--consolidate_citations] [--include_raw_citations]
                      [--include_raw_affiliations] [--force] [--teiCoordinates]
-                     [--verbose]
+                     [--verbose] [--flavor FLAVOR]
                      service
 
 Client for GROBID services
@@ -97,9 +94,13 @@ optional arguments:
   --segmentSentences    segment sentences in the text content of the document
                         with additional <s> elements
   --verbose             print information about processed files in the console
+  --flavor              specifcy the flavor to be used. Current accepted
+                        values: `article/light`, `article/light-ref`, `sdo/ietf`.
+```
 
+> [!TIP]
+> Before using flavors, check [here](https://grobid.readthedocs.io/en/latest/Grobid-specialized-processes/#flavors).
 
-```
 
 Examples:
 
@@ -148,6 +149,9 @@ See also `example.py`.
 
 ## Configuration of the client
 
+> [!TIP]
+> from version 0.0.12 the `config.json` will be optional, by default the client will connect to the local server. 
+
 There are a few parameters that can be set with the `config.json` file. 
 
 - `grobid_server` indicates the URL of the GROBID server to be used by the client. 

grobid_client_python-0.0.13/config.json

@@ -0,0 +1,28 @@
+{
+  "grobid_server": "http://localhost:8070",
+  "batch_size": 1000,
+  "timeout": 120,
+  "sleep_time": 5,
+  "coordinates": [
+    "title",
+    "persName",
+    "affiliation",
+    "orgName",
+    "formula",
+    "figure",
+    "ref",
+    "biblStruct",
+    "head",
+    "p",
+    "s",
+    "note"
+  ],
+  "logging": {
+    "level": "INFO",
+    "format": "%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+    "console": true,
+    "file": null,
+    "max_file_size": "10MB",
+    "backup_count": 3
+  }
+}