Skip to content

Commit

Permalink
Update docs (#516)
Browse files Browse the repository at this point in the history
  • Loading branch information
vinayak-mehta authored Dec 28, 2024
2 parents 2c366d5 + 085a587 commit 597c83b
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 26 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,15 @@
[![codecov.io](https://codecov.io/github/camelot-dev/camelot/badge.svg?branch=master&service=github)](https://codecov.io/github/camelot-dev/camelot?branch=master)
[![image](https://img.shields.io/pypi/v/camelot-py.svg)](https://pypi.org/project/camelot-py/) [![image](https://img.shields.io/pypi/l/camelot-py.svg)](https://pypi.org/project/camelot-py/) [![image](https://img.shields.io/pypi/pyversions/camelot-py.svg)](https://pypi.org/project/camelot-py/)

**Camelot** is a Python library that can help you extract tables from PDFs!
**Camelot** is a Python library that can help you extract tables from PDFs.

---

**Here's how you can extract tables from PDFs.**
You can check out the quickstart notebook. [![image](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/camelot-dev/camelot/blob/master/examples/pypdf_table_extraction_quick_start_notebook.ipynb) or follow the example below.
**Extract tables from PDFs in just a few lines of code:**

You can check out the PDF used in this example [here](https://github.com/camelot-dev/camelot/blob/main/docs/_static/pdf/foo.pdf).
Try it yourself in our interactive quickstart notebook. [![image](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/camelot-dev/camelot/blob/master/examples/pypdf_table_extraction_quick_start_notebook.ipynb)

Or check out a simple example using [this pdf](https://github.com/camelot-dev/camelot/blob/main/docs/_static/pdf/foo.pdf).

<pre>
>>> import camelot
Expand Down
2 changes: 1 addition & 1 deletion camelot/__version__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.12.0"
__version__ = "0.11.0"
17 changes: 8 additions & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,25 +25,24 @@ Release v\ |version|. (:ref:`Installation <install>`)
:target: https://pypi.org/project/camelot-py/


**Camelot** is a Python library that can help you extract tables from PDFs!
**Camelot** is a Python library that can help you extract tables from PDFs.

.. note:: You can also check out `Excalibur`_, the web interface to Camelot!
.. note:: You can also check out `Excalibur`_, the web interface to Camelot.

.. _Excalibur: https://github.com/camelot-dev/excalibur

----

**Here's how you can extract tables from PDFs.**
You can check out the quickstart notebook.
**Extract tables from PDFs in just a few lines of code:**

.. image:: https://colab.research.google.com/assets/colab-badge.svg
:target: https://colab.research.google.com/github/camelot-dev/camelot/blob/master/examples/pypdf_table_extraction_quick_start_notebook.ipynb
.. |colab| image:: https://colab.research.google.com/assets/colab-badge.svg
:target: https://colab.research.google.com/github/camelot-dev/camelot/blob/master/examples/pypdf_table_extraction_quick_start_notebook.ipynb

Or follow the example below.
Try it yourself in our interactive quickstart notebook. |colab|

You can find the PDF used in this example `here`_.
Or check out a simple example using `this pdf`_.

.. _here: _static/pdf/foo.pdf
.. _this pdf: _static/pdf/foo.pdf

.. code-block:: pycon
Expand Down
9 changes: 4 additions & 5 deletions docs/user/how-it-works.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,11 @@ This part of the documentation includes a high-level explanation of how Camelot
You can choose between the following table parsing methods, *Stream*, *Lattice*, *Network* and *Hybrid*.
Where *Hybrid* is a combination of the *Network* and *Lattice* parser.

.. tip::
For a side-by-side visual comparison of the parser use the `parser-comparison-notebook`:

.. image:: https://colab.research.google.com/assets/colab-badge.svg
:target: https://colab.research.google.com/github/camelot-dev/camelot/blob/main/examples/parser-comparison-notebook.ipynb
.. |colab| image:: https://colab.research.google.com/assets/colab-badge.svg
:target: https://colab.research.google.com/github/camelot-dev/camelot/blob/main/examples/parser-comparison-notebook.ipynb

.. tip::
For a side-by-side visual comparison of the parsers use our comparison notebook. |colab|

.. _stream:

Expand Down
11 changes: 5 additions & 6 deletions docs/user/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@
Quickstart
==========

In a hurry to extract tables from PDFs?
This document gives a good introduction to help you get started with Camelot.
Or checkout the quickstart-notebook.
.. |colab| image:: https://colab.research.google.com/assets/colab-badge.svg
:target: https://colab.research.google.com/github/camelot-dev/camelot/blob/master/examples/pypdf_table_extraction_quick_start_notebook.ipynb

.. image:: https://colab.research.google.com/assets/colab-badge.svg
:target: https://colab.research.google.com/github/camelot-dev/camelot/blob/master/examples/pypdf_table_extraction_quick_start_notebook.ipynb
In a hurry to extract tables from PDFs? This document gives a good introduction to help you get started with Camelot.
You can also check out our quickstart notebook. |colab|


ead the PDF
Read the PDF
------------

Reading a PDF to extract tables with Camelot is very simple.
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "camelot"
version = "0.12.0"
version = "0.11.0"
description = "PDF Table Extraction for Humans."
authors = [
{name = "Vinayak Mehta", email = "[email protected]"},
Expand Down Expand Up @@ -67,6 +67,7 @@ dev = [
"typeguard>=2.13.3",
"xdoctest[colors]>=0.15.10",
"myst-parser>=2.0.0",
"nox>=2024.10.9",
]

[project.scripts]
Expand Down

0 comments on commit 597c83b

Please sign in to comment.