Skip to main content

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

Reason this release was yanked:

Wrongly used patched version. Should use 2.4.0 instead

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 to read our documentation especially the FAQ section.

tabula-py example

Requirements

  • Java 8+
  • Python 3.7+

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 example notebook for more details. I also recommend to read the tutorial article written by @aegis4048.

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for tabula-py-2.3.1.tar.gz
Algorithm Hash digest
SHA256 223863e010f8e78bb2cb939013221c68861daa0139aa2cbbbad3a01d238843a0
MD5 0b05c99f58afd1636bae86266fd66a2f
BLAKE2b-256 38b43c38dc4602b5ea07b29a350b737af62c3c111aaa2324a5fcf2ca91a24a08

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for tabula_py-2.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 aa066f87e11ecf18caee0eabed11f1cbee60e91990d2830c369a3cadf400d524
MD5 e5666faa323d128257bf8cd337d514d4
BLAKE2b-256 7653ff5d18484f8db12ca6182b4d58c77ff7e70d7b1be29d5360213125ab71f9

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