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 table of PDF. You can read tables from PDF and convert into pandas's DataFrame. tabula-py also enables you to convert a PDF file into CSV/TSV/JSON file.

You can see the example notebook and try it on Google Colab, or we highly recommend to read our document especially for FAQ.

Requirements

  • Java 8+
  • Python 3.5+

OS

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

Usage

Install

Ensure you have Java runtime and set PATH for it.

pip install tabula-py

Example

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

import tabula

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

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

# convert PDF into CSV
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 detail. 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 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.0.0rc1.tar.gz (10.6 MB view details)

Uploaded Source

Built Distribution

tabula_py-2.0.0rc1-py3-none-any.whl (10.4 MB view details)

Uploaded Python 3

File details

Details for the file tabula-py-2.0.0rc1.tar.gz.

File metadata

  • Download URL: tabula-py-2.0.0rc1.tar.gz
  • Upload date:
  • Size: 10.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.0

File hashes

Hashes for tabula-py-2.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 18aa6e0f16f0d6472ef2991a19e9a40c43e6c079908316f2473e4acefc23b925
MD5 90b53dd36c0fa347a2ae490e67e146b6
BLAKE2b-256 5724cb2c9e83cf894aaf6028c4c2426b545e565189b0986368017c3a5ed699a5

See more details on using hashes here.

File details

Details for the file tabula_py-2.0.0rc1-py3-none-any.whl.

File metadata

  • Download URL: tabula_py-2.0.0rc1-py3-none-any.whl
  • Upload date:
  • Size: 10.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.0

File hashes

Hashes for tabula_py-2.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 2b2b4d9a6913c816b67bd19f7ba36054cbd985e283e61c0620d05e62615e2749
MD5 50efc8fa5d20bc1bc4c6edb332014a37
BLAKE2b-256 153acb2332a18839fbc02aff06669088ae55085de2a6a615e8d604b27c299376

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