This package contains various tools and functions for the OCR of books, with a focus on distributed OCR using short-lived virtual servers.
This is a Go package, and can be installed in the standard go way, by running
go get rescribe.xyz/bookpipeline/... and documentation can be read with the
go doc command or online at https://pkg.go.dev/rescribe.xyz/bookpipeline.
If you just want to install and use the commands, you can get the package with
git clone https://git.rescribe.xyz/bookpipeline, and then install them with
go install ./... from within the
The commands in the cmd/ directory are at the heart of this package. For more details on their usage, use
go doc or read doc.go in the package repository.
The key commands for the virtual server side are:
There are also some commands which are more useful in a standalone setting:
While bookpipeline was built with cloud based operation in mind, there is also a local mode that can be used to run OCR jobs from a single computer, with all the benefits of preprocessing, choosing the best threshold for each image, graph creation, PDF creation, and so on that the pipeline provides.
Several of the commands accept a
-c local flag for local operation, but now there is also a new command, named
rescribe, that is designed to make things much simpler for people just wanting to do some OCR on their local computer.
More information about this, including links to prebuilt executables, can be found on our blog at https://blog.rescribe.xyz/posts/desktop-tool/.
Any and all comments, bug reports, patches or pull requests would be very welcomely received. Please email them to email@example.com.
This package is licensed under the GPLv3. See the LICENSE file for more details.