Skip to content

Read tables in pdf files using camelot for pyexcel community

License

Notifications You must be signed in to change notification settings

pyexcel/pyexcel-pdfr

Repository files navigation

pyexcel-pdfr - Let you focus on data, instead of file formats

https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png https://pepy.tech/badge/pyexcel-pdfr/month https://img.shields.io/static/v1?label=continuous%20templating&message=%E6%A8%A1%E7%89%88%E6%9B%B4%E6%96%B0&color=blue&style=flat-square https://img.shields.io/static/v1?label=coding%20style&message=black&color=black&style=flat-square

Support the project

If your company uses pyexcel and its components in a revenue-generating product, please consider supporting the project on GitHub or Patreon. Your financial support will enable me to dedicate more time to coding, improving documentation, and creating engaging content.

Introduction

pyexcel-pdfr does Read tables in pdf files using camelot for pyexcel community. Please note it works on python 3.6+ only.

It reads only phyical files and does not read io streams, not a URL.

Installation

You can install pyexcel-pdfr via pip:

$ pip install pyexcel-pdfr

or clone it and install it:

$ git clone https://github.com/pyexcel/pyexcel-pdfr.git
$ cd pyexcel-pdfr
$ python setup.py install

Development guide

Development steps for code changes

  1. git clone https://github.com/pyexcel/pyexcel-pdfr.git
  2. cd pyexcel-pdfr

Upgrade your setup tools and pip. They are needed for development and testing only:

  1. pip install --upgrade setuptools pip

Then install relevant development requirements:

  1. pip install -r rnd_requirements.txt # if such a file exists
  2. pip install -r requirements.txt
  3. pip install -r tests/requirements.txt

Once you have finished your changes, please provide test case(s), relevant documentation and update changelog.yml

Note

As to rnd_requirements.txt, usually, it is created when a dependent library is not released. Once the dependency is installed (will be released), the future version of the dependency in the requirements.txt will be valid.

How to test your contribution

Although nose and doctest are both used in code testing, it is advisable that unit tests are put in tests. doctest is incorporated only to make sure the code examples in documentation remain valid across different development releases.

On Linux/Unix systems, please launch your tests like this:

$ make

On Windows, please issue this command:

> test.bat

Before you commit

Please run:

$ make format

so as to beautify your code otherwise your build may fail your unit test.

License

New BSD License