diff --git a/README.md b/README.md index 0ed2db7..672cc25 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ [![Build Status](https://travis-ci.org/fourdigits/wagtail_textract.svg?branch=master)](https://travis-ci.org/fourdigits/wagtail_textract) [![Coverage Report](http://codecov.io/github/fourdigits/wagtail_textract/coverage.svg?branch=master)](http://codecov.io/github/fourdigits/wagtail_textract?branch=master) +[![PyPI version](https://badge.fury.io/py/wagtail-textract.svg)](https://badge.fury.io/py/wagtail-textract) # Text extraction for Wagtail document search @@ -29,18 +30,15 @@ the live search finds it: The assumption is that this search should not only be available in Wagtail's admin interface, but also in a public-facing search view, for which we provide a code example. - ## Requirements - Wagtail 2 (see [tox.ini](./tox.ini)) - The [Textract dependencies][8] - ## Maturity We have been using this package in production since August 2018 on https://nuffic.nl. - ## Installation - Install the [Textract dependencies][8] @@ -57,7 +55,6 @@ textract 1.6.1 has requirement beautifulsoup4==4.5.3, but you'll have beautifuls We haven't seen this leading to problems, but it's something to keep in mind. - ### Tesseract In order to make `textract` use [Tesseract][4], which happens if regular @@ -67,7 +64,6 @@ base its word matching on. Create a `tessdata` directory in your project directory, and download the [languages][5] you want. - ## Transcribing Transcription is done automatically after Document save, @@ -79,7 +75,6 @@ To transcribe all existing Documents, run the management command:: This may take a long time, obviously. - ## Usage in custom view Here is a code example for a search view (outside Wagtail's admin interface) @@ -123,7 +118,6 @@ because you can't do `pageurl result` on a Document: {% endif %} ``` - ## What if you already use a custom Document model? In order to use wagtail_textract, your `CustomizedDocument` model should do @@ -149,19 +143,16 @@ class CustomizedDocument(TranscriptionMixin, ...): Note that the first class to subclass should be `TranscriptionMixin`, so its `save()` takes precedence over that of the other parent classes. - ## Tests To run tests, checkout this repository and: make test - ### Coverage A coverage report will be generated in `./coverage_html_report/`. - ## Contributors - Karl Hobley @@ -174,7 +165,6 @@ A coverage report will be generated in `./coverage_html_report/`. - Dan Braghis - Dan Swain - [1]: https://wagtail.io/ [2]: https://github.com/deanmalmgren/textract [3]: https://github.com/wagtail/wagtail/issues/542