Skip to content

Commit

Permalink
update readme, prepare for 0.0.25
Browse files Browse the repository at this point in the history
  • Loading branch information
phschoepf committed Apr 23, 2024
1 parent ff43f9b commit 2a9de72
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 7 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ The version numbers are according to [Semantic Versioning](http://semver.org/).

### Removed

## Release v0.0.25 (2024-04-23)
### Added
- Optional dependencies for the specific OCR solutions can now be installed via dependency groups, using e.g. `ocr_wrapper[google,azure]`

### Fixed
- Fixed a deadlock when instantiating GoogleOCR clients from multiple threads simultaneously

### Changed
- Configuration now uses pyproject.toml of setup.py

## Release v0.0.24 (2024-04-15)
### Fixed
- Provides the correct solution for the fix from v0.0.23 which did not work relyably.
Expand Down
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,14 @@ For a usage example, see `tryme.ipynb`.
## Requirements
In addition to the automatically installed requirements, you also need to install the packages needed for the individual OCR solutions. These are not automatically installed, since we don't want to force dependencies which are not really needed if you only use one specific OCR solution.

- Google: `google-cloud-vision`
- Google Document checkbox detection `google-cloud-documentai`
- AWS: `boto3`
- Azure: `azure-cognitiveservices-vision-computervision`
- PaddleOCR: `paddleocr`
- EasyOCR: `easyocr`
Use the following dependency groups to install the required packages for the OCR solutions you want to use:

- Azure: `ocr_wrapper[azure]`
- Google: `ocr_wrapper[google]`
- GoogleAzure: `ocr_wrapper[googleazure]` - this also supports checkbox detection
- AWS: `ocr_wrapper[aws]`
- EasyOCR: `ocr_wrapper[easy]`
- PaddleOCR: `ocr_wrapper[paddle]`

Depending on your operating system you might also have to install the Noto Sans font package (e.g. `noto-sans` in Ubuntu)

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "ocr_wrapper"
version = "0.0.24"
version = "0.0.25"
license.file = "LICENSE.md"
authors = [{ name = "DeepOpinion", email = "hello@deepopinion.ai" }]
urls.repository = "https://github.com/deepopinion/ocr_wrapper"
Expand Down

0 comments on commit 2a9de72

Please sign in to comment.