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.8.2.tar.gz (12.5 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file tabula-py-2.8.2.tar.gz.

File metadata

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

File hashes

Hashes for tabula-py-2.8.2.tar.gz
Algorithm Hash digest
SHA256 d73593a11c29e1c14b1a0ede91cd5ef63668118f8a2b085fe77e78c616b1cb33
MD5 8967cad8a534c0f1ac997b037fd73df1
BLAKE2b-256 bbfde5dc93f8b9227677bdecc0d7490347c84d8885f9a63d0db000997e0b6d2d

See more details on using hashes here.

File details

Details for the file tabula_py-2.8.2-py3-none-any.whl.

File metadata

  • Download URL: tabula_py-2.8.2-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.5

File hashes

Hashes for tabula_py-2.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 046d1680959cb5a146f92d9c0c6fb16f68ee2820f541ddbc1df986bfe737aa81
MD5 97fa5a1106f7bf7298ae84b9777deb05
BLAKE2b-256 b8037417bf7b73ec99bc3675cc25b5f117ee6013f3982951f0a0ea6563cda80f

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