Home

Awesome

<p align="center"> <img src="https://raw.githubusercontent.com/camelot-dev/camelot/master/docs/_static/camelot.png" width="200"> </p>

Camelot: PDF Table Extraction for Humans

Build Status Documentation Status codecov.io image image image Gitter chat image

Camelot is a Python library that makes it easy for anyone to extract tables from PDF files!

Note: You can also check out Excalibur, which is a web interface for Camelot!


Here's how you can extract tables from PDF files. Check out the PDF used in this example here.

<pre> >>> import camelot >>> tables = camelot.read_pdf('foo.pdf') >>> tables &lt;TableList n=1&gt; >>> tables.export('foo.csv', f='csv', compress=True) # json, excel, html, sqlite >>> tables[0] &lt;Table shape=(7, 7)&gt; >>> tables[0].parsing_report { 'accuracy': 99.02, 'whitespace': 12.24, 'order': 1, 'page': 1 } >>> tables[0].to_csv('foo.csv') # to_json, to_excel, to_html, to_sqlite >>> tables[0].df # get a pandas DataFrame! </pre>
Cycle NameKI (1/km)Distance (mi)Percent Fuel Savings
Improved SpeedDecreased AccelEliminate StopsDecreased Idle
2012_23.301.35.9%9.5%29.2%17.4%
2145_10.6811.22.4%0.1%9.5%2.7%
4234_10.5958.78.5%1.3%8.5%3.3%
2032_20.1757.821.7%0.3%2.7%1.2%
4171_10.07173.958.1%1.6%2.1%0.5%

There's a command-line interface too!

Note: Camelot only works with text-based PDFs and not scanned documents. (As Tabula explains, "If you can click and drag to select text in your table in a PDF viewer, then your PDF is text-based".)

Why Camelot?

See comparison with other PDF table extraction libraries and tools.

Installation

Using conda

The easiest way to install Camelot is to install it with conda, which is a package manager and environment management system for the Anaconda distribution.

<pre> $ conda install -c conda-forge camelot-py </pre>

Using pip

After installing the dependencies (tk and ghostscript), you can simply use pip to install Camelot:

<pre> $ pip install camelot-py[cv] </pre>

From the source code

After installing the dependencies, clone the repo using:

<pre> $ git clone https://www.github.com/camelot-dev/camelot </pre>

and install Camelot using pip:

<pre> $ cd camelot $ pip install ".[cv]" </pre>

Documentation

Great documentation is available at http://camelot-py.readthedocs.io/.

Development

The Contributor's Guide has detailed information about contributing code, documentation, tests and more. We've included some basic information in this README.

Source code

You can check the latest sources with:

<pre> $ git clone https://www.github.com/camelot-dev/camelot </pre>

Setting up a development environment

You can install the development dependencies easily, using pip:

<pre> $ pip install camelot-py[dev] </pre>

Testing

After installation, you can run tests using:

<pre> $ python setup.py test </pre>

Versioning

Camelot uses Semantic Versioning. For the available versions, see the tags on this repository. For the changelog, you can check out HISTORY.md.

License

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

<img src="https://user-images.githubusercontent.com/408863/66741678-a78ab780-ee93-11e9-8d90-b274af222339.png" align="centre" />