diff --git a/README.md b/README.md index 40cc9db..f117a49 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,15 @@ There's a [command-line interface](https://camelot-py.readthedocs.io/en/latest/user/cli.html) too! +--- + +**Note:** Camelot only works with: + +- Python 2, with Python 3 support [on the way](https://github.com/socialcopsdev/camelot/issues/81). +- Text-based PDFs and not scanned documents. If you can click-and-drag to select text in your table in a PDF viewer, then your PDF is text-based. Support for image-based PDFs using OCR is [planned](https://github.com/socialcopsdev/camelot/issues/101). + +--- + ## Why Camelot? - **You are in control**: Unlike other libraries and tools which either give a nice output or fail miserably (with no in-between), Camelot gives you the power to tweak table extraction. (Since everything in the real world, including PDF table extraction, is fuzzy.) diff --git a/docs/index.rst b/docs/index.rst index d9a2fcb..99a1869 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,15 +25,7 @@ Release v\ |version|. (:ref:`Installation `) **Camelot** is a Python library which makes it easy for *anyone* to extract tables from PDF files! -.. note:: Camelot only works with: - - - Python 2, with **Python 3** support `on the way`_. - - Text-based PDFs and not scanned documents. If you can click-and-drag to select text in your table in a PDF viewer, then your PDF is text-based. Support for image-based PDFs using **OCR** is `planned`_. - -.. _on the way: https://github.com/socialcopsdev/camelot/issues/81 -.. _planned: https://github.com/socialcopsdev/camelot/issues/101 - ------------------------- +---- **Here's how you can extract tables from PDF files.** Check out the PDF used in this example, `here`_. @@ -63,6 +55,14 @@ Release v\ |version|. (:ref:`Installation `) There's a :ref:`command-line interface ` too! +.. note:: Camelot only works with: + + - Python 2, with **Python 3** support `on the way`_. + - Text-based PDFs and not scanned documents. If you can click-and-drag to select text in your table in a PDF viewer, then your PDF is text-based. Support for image-based PDFs using **OCR** is `planned`_. + +.. _on the way: https://github.com/socialcopsdev/camelot/issues/81 +.. _planned: https://github.com/socialcopsdev/camelot/issues/101 + Why Camelot? ------------