Skip to main content

A wrapper around tesseract that can be easily called from the command line on an image from the clipboard

Project description

OCR Shell

OCR Shell is a convenient command-line tool for quick and easy text extraction from images. Whether you have an image in your clipboard or a saved file, OCR Shell makes it easy to extract text without the hassle of manual handling.

Prerequisite

Tesseract OCR

  • On Windows, you can download an installer from the Tesseract GitHub repository.
  • On macOS, you can install Tesseract using Homebrew with the command brew install tesseract.

Make sure the tesseract is found on your executable PATH.

Installation

To install OCR Shell, simply run:

pip install ocr-shell

This command will install OCR Shell and all its dependencies.

Usage

From Clipboard

To extract text from an image in your clipboard, just type:

$ ocr
... text found in the copied image ...

From a File

OCR Shell also works with saved images. Just provide the path to the image:

$ ocr ~/Desktop/Screenshot.png
... more text extracted ...

Unit Tests

$ python -m unittest discover
..
----------------------------------------------------------------------
Ran 2 tests in 0.407s

OK

Contributing

Contributions to OCR Shell are welcome! Whether it's bug reports, feature requests, or code contributions, your input is valuable. To contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Commit your changes.
  4. Push to your branch.
  5. Submit a pull request.

Please make sure to update tests as appropriate.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Thanks to the Tesseract OCR team for their amazing work.
  • Matt King for initial development.
  • All contributors who help to improve OCR Shell.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ocr-shell-0.2.0.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ocr_shell-0.2.0-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file ocr-shell-0.2.0.tar.gz.

File metadata

  • Download URL: ocr-shell-0.2.0.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for ocr-shell-0.2.0.tar.gz
Algorithm Hash digest
SHA256 edfad41f92169359f795e81f03b1f1ec42c81fbcefe41783baadd19390e7ebd4
MD5 4b9d02beab41f53b8f65a5f9151cf0c4
BLAKE2b-256 aa082f22d34d9acea0a998e04910ca0bcf9795340826cd5e05366107a497530d

See more details on using hashes here.

File details

Details for the file ocr_shell-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: ocr_shell-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 4.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for ocr_shell-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b985b8a3737fba756655b9cfd4d6a04ad12de165770088d12eda4708689946f4
MD5 93989b49016741801659978aca21c630
BLAKE2b-256 4c443cdbb5eb59cffb7695d4a33ca8542b55fbe9d78a40599f5786f6ea9a0075

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page