# pyexcel-pdfr

**Repository Path**: mirrors_pyexcel/pyexcel-pdfr

## Basic Information

- **Project Name**: pyexcel-pdfr
- **Description**: Read tables in pdf files using camelot for pyexcel community
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2026-10-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

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

.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png
   :target: https://www.patreon.com/chfw

.. image:: https://codecov.io/gh/pyexcel/pyexcel-pdfr/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/pyexcel/pyexcel-pdfr

.. image:: https://badge.fury.io/py/pyexcel-pdfr.svg
   :target: https://pypi.org/project/pyexcel-pdfr



.. image:: https://pepy.tech/badge/pyexcel-pdfr/month
   :target: https://pepy.tech/project/pyexcel-pdfr


.. image:: 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
    :target: https://moban.readthedocs.io/en/latest/#at-scale-continous-templating-for-open-source-projects

.. image:: https://img.shields.io/static/v1?label=coding%20style&message=black&color=black&style=flat-square
    :target: https://github.com/psf/black

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 <https://www.patreon.com/bePatron?u=5537627>`_. 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 <https://github.com/atlanhq/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:

.. code-block:: bash

    $ pip install pyexcel-pdfr


or clone it and install it:

.. code-block:: bash

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



Development guide
================================================================================

Development steps for code changes

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

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

#. pip install --upgrade setuptools pip

Then install relevant development requirements:

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

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

.. 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.

Before you raise pull request
--------------------------------------------------------------------------------

Please edit 'changelog.yml' and record your changes



License
================================================================================

New BSD License