Skip to main content

Simple wrapper for tabula-java, read tables from PDF into DataFrame

Project description

tabula-py

Build Status PyPI version Documentation Status Patreon

tabula-py is a simple Python wrapper of tabula-java, which can read tables in a PDF. You can read tables from a PDF and convert them into a pandas DataFrame. tabula-py also enables you to convert a PDF file into a CSV, a TSV or a JSON file.

You can see the example notebook and try it on Google Colab, or we highly recommend reading our documentation, especially the FAQ section.

tabula-py example

Requirements

  • Java 8+
  • Python 3.8+

OS

I confirmed working on macOS and Ubuntu. But some people confirm it works on Windows 10. See also the documentation for the detailed installation for Windows 10.

Usage

Install

Ensure you have a Java runtime and set the PATH for it.

pip install tabula-py

Example

tabula-py enables you to extract tables from a PDF into a DataFrame, or a JSON. It can also extract tables from a PDF and save the file as a CSV, a TSV, or a JSON.  

import tabula

# Read pdf into list of DataFrame
dfs = tabula.read_pdf("test.pdf", pages='all')

# Read remote pdf into list of DataFrame
dfs2 = tabula.read_pdf("https://github.com/tabulapdf/tabula-java/raw/master/src/test/resources/technology/tabula/arabic.pdf")

# convert PDF into CSV file
tabula.convert_into("test.pdf", "output.csv", output_format="csv", pages='all')

# convert all PDFs in a directory
tabula.convert_into_by_batch("input_directory", output_format='csv', pages='all')

See an example notebook for more details. I also recommend reading the tutorial article written by @aegis4048, and another tutorial written by @tdpetrou.

Contributing

Interested in helping out? I'd love to have your help!

You can help by:

  • Reporting a bug.
  • Adding or editing documentation.
  • Contributing code via a Pull Request. See also for the contribution
  • Write a blog post or spread the word about tabula-py to people who might be able to benefit from using it.

Contributors

Another support

You can also support our continued work on tabula-py with a donation on GitHub Sponsors or Patreon.

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

tabula-py-2.7.0rc0.tar.gz (12.5 MB view details)

Uploaded Source

Built Distribution

tabula_py-2.7.0rc0-py3-none-any.whl (12.0 MB view details)

Uploaded Python 3

File details

Details for the file tabula-py-2.7.0rc0.tar.gz.

File metadata

  • Download URL: tabula-py-2.7.0rc0.tar.gz
  • Upload date:
  • Size: 12.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for tabula-py-2.7.0rc0.tar.gz
Algorithm Hash digest
SHA256 cfa4aaa6315e41af6ec0288ddae372259aaeac3e89284cc31d8462fc9b385e93
MD5 ba70c241b679d0435c071d464d1ce772
BLAKE2b-256 18c9316b8d4217655979b7d3647b3adc83e09712353f6c38fa0dd3f625a4ac9f

See more details on using hashes here.

File details

Details for the file tabula_py-2.7.0rc0-py3-none-any.whl.

File metadata

  • Download URL: tabula_py-2.7.0rc0-py3-none-any.whl
  • Upload date:
  • Size: 12.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for tabula_py-2.7.0rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 57148d94c7972a1f974a208c4cfc9c2e08ff11536dcb54c26751801cfa410fc1
MD5 12e1172b22ab2daac4203c6f1f21143b
BLAKE2b-256 d2cc5cfdc08582cf868d80470288ded9c690b432279171ea835d35b167bac838

See more details on using hashes here.

Supported by

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