# WinOCR
[](https://badge.fury.io/py/winocr)
[](https://badge.fury.io/py/winocr)
# Installation
```powershell
pip install winocr
```
<details>
<summary>Full install</summary>
```powershell
pip install winocr[all]
```
</details>
# Usage
## Pillow
The language to be recognized can be specified by the lang parameter (second argument).
```python
import winocr
from PIL import Image
img = Image.open('test.jpg')
(await winocr.recognize_pil(img, 'ja')).text
```
## OpenCV
```python
import winocr
import cv2
img = cv2.imread('test.jpg')
(await winocr.recognize_cv2(img, 'ja')).text
```
## Connect to local runtime on Colaboratory
Create a local connection by following [these instructions](https://research.google.com/colaboratory/local-runtimes.html).
```powershell
pip install jupyterlab jupyter_http_over_ws
jupyter serverextension enable --py jupyter_http_over_ws
jupyter notebook --NotebookApp.allow_origin='https://colab.research.google.com' --ip=0.0.0.0 --port=8888 --NotebookApp.port_retries=0
```
Also available on Jupyter / Jupyter Lab.
## REPL
```python
import cv2
from winocr import recognize_cv2_sync
img = cv2.imread('testocr.png')
recognize_cv2_sync(img)['text']
'This is a lot of 12 point text to test the ocr code and see if it works on all types of file format. The quick brown dog jumped over the lazy fox. The quick brown dog jumped over the lazy fox. The quick brown dog jumped over the lazy fox. The quick brown dog jumped over the lazy fox.'
```
```python
from PIL import Image
from winocr import recognize_pil_sync
img = Image.open('testocr.png')
recognize_pil_sync(img)['text']
'This is a lot of 12 point text to test the ocr code and see if it works on all types of file format. The quick brown dog jumped over the lazy fox. The quick brown dog jumped over the lazy fox. The quick brown dog jumped over the lazy fox. The quick brown dog jumped over the lazy fox.'
```
## Multi-Processing
```python
from PIL import Image
import concurrent.futures
from winocr import recognize_pil_sync
images = [Image.open('testocr.png') for i in range(1000)]
with concurrent.futures.ProcessPoolExecutor() as executor:
results = list(executor.map(recognize_pil_sync, images))
print(results)
```
## Web API
Run server
```powershell
pip install winocr[api]
winocr_serve
```
### curl
```bash
curl localhost:8000?lang=ja --data-binary @test.jpg
```
### Python
```python
import requests
bytes = open('test.jpg', 'rb').read()
requests.post('http://localhost:8000/?lang=ja', bytes).json()['text']
```
You can run OCR with the Colaboratory runtime with `./ngrok http 8000`
```python
from PIL import Image
from io import BytesIO
img = Image.open('test.jpg')
# Preprocessing
buf = BytesIO()
img.save(buf, format='JPEG')
requests.post('https://15a5fabf0d78.ngrok.io/?lang=ja', buf.getvalue()).json()['text']
```
```python
import cv2
import requests
img = cv2.imread('test.jpg')
# Preprocessing
requests.post('https://15a5fabf0d78.ngrok.io/?lang=ja', cv2.imencode('.jpg', img)[1].tobytes()).json()['text']
```
### JavaScript
If you only need to recognize Chrome and English, you can also consider the Text Detection API.
```javascript
// File
const file = document.querySelector('[type=file]').files[0]
await fetch('http://localhost:8000/', {method: 'POST', body: file}).then(r => r.json())
// Blob
const blob = await fetch('https://image.itmedia.co.jp/ait/articles/1706/15/news015_16.jpg').then(r=>r.blob())
await fetch('http://localhost:8000/?lang=ja', {method: 'POST', body: blob}).then(r => r.json())
```
It is also possible to run OCR Server on Windows Server.
# Information that can be obtained
You can get **angle**, **text**, **line**, **word**, **BoundingBox**.
```python
import pprint
result = await winocr.recognize_pil(img, 'ja')
pprint.pprint({
'text_angle': result.text_angle,
'text': result.text,
'lines': [{
'text': line.text,
'words': [{
'bounding_rect': {'x': word.bounding_rect.x, 'y': word.bounding_rect.y, 'width': word.bounding_rect.width, 'height': word.bounding_rect.height},
'text': word.text
} for word in line.words]
} for line in result.lines]
})
```
# Language installation
```powershell
# Run as Administrator
Add-WindowsCapability -Online -Name "Language.OCR~~~en-US~0.0.1.0"
Add-WindowsCapability -Online -Name "Language.OCR~~~ja-JP~0.0.1.0"
# Search for installed languages
Get-WindowsCapability -Online -Name "Language.OCR*"
# State: Not Present language is not installed, so please install it if necessary.
Name : Language.OCR~~~hu-HU~0.0.1.0
State : NotPresent
DisplayName : ハンガリー語の光学式文字認識
Description : ハンガリー語の光学式文字認識
DownloadSize : 194407
InstallSize : 535714
Name : Language.OCR~~~it-IT~0.0.1.0
State : NotPresent
DisplayName : イタリア語の光学式文字認識
Description : イタリア語の光学式文字認識
DownloadSize : 159875
InstallSize : 485922
Name : Language.OCR~~~ja-JP~0.0.1.0
State : Installed
DisplayName : 日本語の光学式文字認識
Description : 日本語の光学式文字認識
DownloadSize : 1524589
InstallSize : 3398536
Name : Language.OCR~~~ko-KR~0.0.1.0
State : NotPresent
DisplayName : 韓国語の光学式文字認識
Description : 韓国語の光学式文字認識
DownloadSize : 3405683
InstallSize : 7890408
```
If you hate Python and just want to recognize it with PowerShell, click [here](https://gist.github.com/GitHub30/8bc1e784148e4f9801520c7e7ba191ea)
# Multi-Processing
By processing in parallel, it is 3 times faster. You can make it even faster by increasing the number of cores!
```python
from PIL import Image
images = [Image.open('testocr.png') for i in range(1000)]
```
### 1 core(elapsed 48s)
The CPU is not used up.
```python
import winocr
[(await winocr.recognize_pil(img)).text for img in images]
```
### 4 cores(elapsed 16s)
I'm using 100% CPU.
Create a worker module.
```python
%%writefile worker.py
import winocr
import asyncio
async def ensure_coroutine(awaitable):
return await awaitable
def recognize_pil_text(img):
return asyncio.run(ensure_coroutine(winocr.recognize_pil(img))).text
```
```python
import worker
import concurrent.futures
with concurrent.futures.ProcessPoolExecutor() as executor:
# https://stackoverflow.com/questions/62488423
results = executor.map(worker.recognize_pil_text, images)
list(results)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/GitHub30/winocr",
"name": "winocr",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Tomofumi Inoue",
"author_email": "funaox@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/46/d6/98fa493ecd6b9c411351e1d01ab6da770ae5c534046fd158fe53b689550b/winocr-0.0.15.tar.gz",
"platform": null,
"description": "# WinOCR\n[](https://badge.fury.io/py/winocr)\n[](https://badge.fury.io/py/winocr)\n\n# Installation\n```powershell\npip install winocr\n```\n\n<details>\n <summary>Full install</summary>\n \n ```powershell\n pip install winocr[all]\n ```\n</details>\n\n# Usage\n\n## Pillow\n\nThe language to be recognized can be specified by the lang parameter (second argument).\n\n```python\nimport winocr\nfrom PIL import Image\n\nimg = Image.open('test.jpg')\n(await winocr.recognize_pil(img, 'ja')).text\n```\n\n\n## OpenCV\n\n```python\nimport winocr\nimport cv2\n\nimg = cv2.imread('test.jpg')\n(await winocr.recognize_cv2(img, 'ja')).text\n```\n\n\n## Connect to local runtime on Colaboratory\n\nCreate a local connection by following [these instructions](https://research.google.com/colaboratory/local-runtimes.html).\n\n```powershell\npip install jupyterlab jupyter_http_over_ws\njupyter serverextension enable --py jupyter_http_over_ws\njupyter notebook --NotebookApp.allow_origin='https://colab.research.google.com' --ip=0.0.0.0 --port=8888 --NotebookApp.port_retries=0\n```\n\n\n\n\n\nAlso available on Jupyter / Jupyter Lab.\n\n## REPL\n\n```python\nimport cv2\nfrom winocr import recognize_cv2_sync\n\nimg = cv2.imread('testocr.png')\nrecognize_cv2_sync(img)['text']\n'This is a lot of 12 point text to test the ocr code and see if it works on all types of file format. The quick brown dog jumped over the lazy fox. The quick brown dog jumped over the lazy fox. The quick brown dog jumped over the lazy fox. The quick brown dog jumped over the lazy fox.'\n```\n\n```python\nfrom PIL import Image\nfrom winocr import recognize_pil_sync\n\nimg = Image.open('testocr.png')\nrecognize_pil_sync(img)['text']\n'This is a lot of 12 point text to test the ocr code and see if it works on all types of file format. The quick brown dog jumped over the lazy fox. The quick brown dog jumped over the lazy fox. The quick brown dog jumped over the lazy fox. The quick brown dog jumped over the lazy fox.'\n```\n\n## Multi-Processing\n\n```python\nfrom PIL import Image\nimport concurrent.futures\nfrom winocr import recognize_pil_sync\n\nimages = [Image.open('testocr.png') for i in range(1000)]\n\nwith concurrent.futures.ProcessPoolExecutor() as executor:\n results = list(executor.map(recognize_pil_sync, images))\nprint(results)\n```\n\n## Web API\n\nRun server\n```powershell\npip install winocr[api]\nwinocr_serve\n```\n\n### curl\n\n```bash\ncurl localhost:8000?lang=ja --data-binary @test.jpg\n```\n\n\n### Python\n\n```python\nimport requests\n\nbytes = open('test.jpg', 'rb').read()\nrequests.post('http://localhost:8000/?lang=ja', bytes).json()['text']\n```\n\n\n\nYou can run OCR with the Colaboratory runtime with `./ngrok http 8000`\n\n```python\nfrom PIL import Image\nfrom io import BytesIO\n\nimg = Image.open('test.jpg')\n# Preprocessing\nbuf = BytesIO()\nimg.save(buf, format='JPEG')\nrequests.post('https://15a5fabf0d78.ngrok.io/?lang=ja', buf.getvalue()).json()['text']\n```\n\n\n```python\nimport cv2\nimport requests\n\nimg = cv2.imread('test.jpg')\n# Preprocessing\nrequests.post('https://15a5fabf0d78.ngrok.io/?lang=ja', cv2.imencode('.jpg', img)[1].tobytes()).json()['text']\n```\n\n\n### JavaScript\n\nIf you only need to recognize Chrome and English, you can also consider the Text Detection API.\n\n```javascript\n// File\nconst file = document.querySelector('[type=file]').files[0]\nawait fetch('http://localhost:8000/', {method: 'POST', body: file}).then(r => r.json())\n\n// Blob\nconst blob = await fetch('https://image.itmedia.co.jp/ait/articles/1706/15/news015_16.jpg').then(r=>r.blob())\nawait fetch('http://localhost:8000/?lang=ja', {method: 'POST', body: blob}).then(r => r.json())\n```\n\nIt is also possible to run OCR Server on Windows Server.\n\n# Information that can be obtained\nYou can get **angle**, **text**, **line**, **word**, **BoundingBox**.\n\n```python\nimport pprint\n\nresult = await winocr.recognize_pil(img, 'ja')\npprint.pprint({\n 'text_angle': result.text_angle,\n 'text': result.text,\n 'lines': [{\n 'text': line.text,\n 'words': [{\n 'bounding_rect': {'x': word.bounding_rect.x, 'y': word.bounding_rect.y, 'width': word.bounding_rect.width, 'height': word.bounding_rect.height},\n 'text': word.text\n } for word in line.words]\n } for line in result.lines]\n})\n```\n\n\n# Language installation\n```powershell\n# Run as Administrator\nAdd-WindowsCapability -Online -Name \"Language.OCR~~~en-US~0.0.1.0\"\nAdd-WindowsCapability -Online -Name \"Language.OCR~~~ja-JP~0.0.1.0\"\n\n# Search for installed languages\nGet-WindowsCapability -Online -Name \"Language.OCR*\"\n# State: Not Present language is not installed, so please install it if necessary.\nName : Language.OCR~~~hu-HU~0.0.1.0\nState : NotPresent\nDisplayName : \u30cf\u30f3\u30ac\u30ea\u30fc\u8a9e\u306e\u5149\u5b66\u5f0f\u6587\u5b57\u8a8d\u8b58\nDescription : \u30cf\u30f3\u30ac\u30ea\u30fc\u8a9e\u306e\u5149\u5b66\u5f0f\u6587\u5b57\u8a8d\u8b58\nDownloadSize : 194407\nInstallSize : 535714\n\nName : Language.OCR~~~it-IT~0.0.1.0\nState : NotPresent\nDisplayName : \u30a4\u30bf\u30ea\u30a2\u8a9e\u306e\u5149\u5b66\u5f0f\u6587\u5b57\u8a8d\u8b58\nDescription : \u30a4\u30bf\u30ea\u30a2\u8a9e\u306e\u5149\u5b66\u5f0f\u6587\u5b57\u8a8d\u8b58\nDownloadSize : 159875\nInstallSize : 485922\n\nName : Language.OCR~~~ja-JP~0.0.1.0\nState : Installed\nDisplayName : \u65e5\u672c\u8a9e\u306e\u5149\u5b66\u5f0f\u6587\u5b57\u8a8d\u8b58\nDescription : \u65e5\u672c\u8a9e\u306e\u5149\u5b66\u5f0f\u6587\u5b57\u8a8d\u8b58\nDownloadSize : 1524589\nInstallSize : 3398536\n\nName : Language.OCR~~~ko-KR~0.0.1.0\nState : NotPresent\nDisplayName : \u97d3\u56fd\u8a9e\u306e\u5149\u5b66\u5f0f\u6587\u5b57\u8a8d\u8b58\nDescription : \u97d3\u56fd\u8a9e\u306e\u5149\u5b66\u5f0f\u6587\u5b57\u8a8d\u8b58\nDownloadSize : 3405683\nInstallSize : 7890408\n```\n\nIf you hate Python and just want to recognize it with PowerShell, click [here](https://gist.github.com/GitHub30/8bc1e784148e4f9801520c7e7ba191ea)\n\n# Multi-Processing\n\nBy processing in parallel, it is 3 times faster. You can make it even faster by increasing the number of cores!\n\n```python\nfrom PIL import Image\n\nimages = [Image.open('testocr.png') for i in range(1000)]\n```\n\n### 1 core(elapsed 48s)\n\nThe CPU is not used up.\n\n\n```python\nimport winocr\n\n[(await winocr.recognize_pil(img)).text for img in images]\n```\n\n\n### 4 cores(elapsed 16s)\n\nI'm using 100% CPU.\n\n\n\nCreate a worker module.\n```python\n%%writefile worker.py\nimport winocr\nimport asyncio\n\nasync def ensure_coroutine(awaitable):\n return await awaitable\n\ndef recognize_pil_text(img):\n return asyncio.run(ensure_coroutine(winocr.recognize_pil(img))).text\n```\n\n```python\nimport worker\nimport concurrent.futures\n\nwith concurrent.futures.ProcessPoolExecutor() as executor:\n # https://stackoverflow.com/questions/62488423\n results = executor.map(worker.recognize_pil_text, images)\nlist(results)\n```\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Windows.Media.Ocr",
"version": "0.0.15",
"project_urls": {
"Bug Tracker": "https://github.com/GitHub30/winocr/issues",
"Homepage": "https://github.com/GitHub30/winocr"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cb6cc076c34b70df9fbb84df1dc61cc5be5f36438afc81ecde6dc0e33ed68d24",
"md5": "6a7999a117380d5171bc67f03fe71f6a",
"sha256": "48ff0a0a2dbcd1f7e84b4fb22575f5d4aba0ec99fdfe07fb0d04254d00826f18"
},
"downloads": -1,
"filename": "winocr-0.0.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6a7999a117380d5171bc67f03fe71f6a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7665,
"upload_time": "2024-10-25T04:11:56",
"upload_time_iso_8601": "2024-10-25T04:11:56.203116Z",
"url": "https://files.pythonhosted.org/packages/cb/6c/c076c34b70df9fbb84df1dc61cc5be5f36438afc81ecde6dc0e33ed68d24/winocr-0.0.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46d698fa493ecd6b9c411351e1d01ab6da770ae5c534046fd158fe53b689550b",
"md5": "c130546c1a523fdb3a23bb5176b790d5",
"sha256": "767f85e8331f6348985813f37763b21838090d23acd9afdd372fb1f7cabc3881"
},
"downloads": -1,
"filename": "winocr-0.0.15.tar.gz",
"has_sig": false,
"md5_digest": "c130546c1a523fdb3a23bb5176b790d5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8120,
"upload_time": "2024-10-25T04:11:57",
"upload_time_iso_8601": "2024-10-25T04:11:57.677705Z",
"url": "https://files.pythonhosted.org/packages/46/d6/98fa493ecd6b9c411351e1d01ab6da770ae5c534046fd158fe53b689550b/winocr-0.0.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-25 04:11:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GitHub30",
"github_project": "winocr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "winocr"
}
JSON
