🧑‍🎓 Quickstart notebook (#231)

* Added a quick start Colab notebook to test functionalities and familiarize users with the library. * changed PyPDF2 to pypdf * Created using Colab * rename PyPDF2 to pypdf and updated dependencies * updated Colab URL to point to a GitHub Gist * Update examples/camelot_quick_start_notebook.ipynb Co-authored-by: bosd <[email protected]> * updating camelot to pypdf-table-extraction * updating camelot to pypdf-table-extraction * added pretty displays of results * Improvements and new namespace for quickstart * Quickstart reflect new name * Add badge to quickstart notebook in doc's --------- Co-authored-by: Alex Fazio <[email protected]>
py-pdf · Nov 2, 2024 · d2b76a9 · d2b76a9
1 parent 58a8317
commit d2b76a9
Show file tree

Hide file tree

Showing 4 changed files with 449 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -12,7 +12,11 @@
 
 ---
 
-**Here's how you can extract tables from PDFs.** You can check out the PDF used in this example [here](https://github.com/py-pdf/pypdf_table_extraction/blob/main/docs/_static/pdf/foo.pdf).
+**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/py-pdf/pypdf_table_extraction/blob/main/examples/pypdf_table_extraction_quick_start_notebook.ipynb)
+
+Or follow the example below.
+You can check out the PDF used in this example [here](https://github.com/py-pdf/pypdf_table_extraction/blob/main/docs/_static/pdf/foo.pdf).
 
 ```python3
 >>> import camelot

diff --git a/docs/index.rst b/docs/index.rst
@@ -32,7 +32,14 @@ Release v\ |version|. (:ref:`Installation <install>`)
 
 ----
 
-**Here's how you can extract tables from PDFs.** You can check out the PDF used in this example `here`_.
+**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
+    :target: https://colab.research.google.com/github/py-pdf/pypdf_table_extraction/blob/main/examples/pypdf_table_extraction_quick_start_notebook.ipynb
+
+Or follow the example below.
+You can find the PDF used in this example `here`_.
 
 .. _here: _static/pdf/foo.pdf
 

diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst
@@ -3,7 +3,13 @@
 Quickstart
 ==========
 
-In a hurry to extract tables from PDFs? This document gives a good introduction to help you get started with pypdf_table_extraction.
+In a hurry to extract tables from PDFs?
+This document gives a good introduction to help you get started with pypdf_table_extraction.
+Or checkout the quickstart-notebook.
+
+.. image:: https://colab.research.google.com/assets/colab-badge.svg
+    :target: https://colab.research.google.com/github/py-pdf/pypdf_table_extraction/blob/quickstart-notebook/examples/pypdf_table_extraction_quick_start_notebook.ipynb
+
 
 Read the PDF
 ------------