From 77368a5d002b1d6c754a93c2c1c9061d7317a2fa Mon Sep 17 00:00:00 2001 From: Mark Pfeifle Date: Sun, 1 Oct 2023 19:27:21 -0400 Subject: [PATCH 1/2] Update README.md Added link to CONTRIBUTING.md in the "Contributions" section and added common questions and answers in the Q&A section. --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 440464971..ed7deb3b6 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,7 @@ For questions and answers, visit Maintaining pypdf is a collaborative effort. You can support the project by writing documentation, helping to narrow down issues, and submitting code. +See the [CONTRIBUTING.md](https://github.com/py-pdf/pypdf/blob/main/CONTRIBUTING.md) file for more information. ### Q&A @@ -71,8 +72,22 @@ want to make their live easier to experts who developed software before PDF existed. You can contribute to the pypdf community by answering questions on [StackOverflow](https://stackoverflow.com/questions/tagged/pypdf), helping in [discussions](https://github.com/py-pdf/pypdf/discussions), -and asking users who report issues for [MCVE](https://stackoverflow.com/help/minimal-reproducible-example)'s (Code + example PDF!). +and asking users who report issues for [MCVE](https://stackoverflow.com/help/minimal-reproducible-example)'s (Code + example PDF!). +The following is some of the most commonly asked questions: +**I get the following error message when I use the pypdf module: ImportError: No module named 'pyPDF'** + +To fix this issue, be sure that you are using the correct name when importing the module. The name of the module is pypdf. +Also, be sure you are using the correct version of pypdf. pypdf 3.1.0 and above are recommended. Use pypdf>=3.1.0 if the issue persists. + +**How can I use pypdf to merge pdf files?** + +Use the PdfMerger class. The append method is great for simply concatenating files, but merge can be used +for more precise control. + +**How can I extract text from a pdf?** + +There are several ways of extracting text from a pdf file using pypdf. The extractText method is likely the simplest way of doing this. ### Issues From eaa387828362952cac0ea8d281e1fd1d9e47e622 Mon Sep 17 00:00:00 2001 From: Martin Thoma Date: Sat, 7 Oct 2023 09:51:31 +0200 Subject: [PATCH 2/2] Apply suggestions from code review --- README.md | 16 +--------------- 1 file changed, 1 insertion(+), 15 deletions(-) diff --git a/README.md b/README.md index ed7deb3b6..3ee95f9a8 100644 --- a/README.md +++ b/README.md @@ -72,22 +72,8 @@ want to make their live easier to experts who developed software before PDF existed. You can contribute to the pypdf community by answering questions on [StackOverflow](https://stackoverflow.com/questions/tagged/pypdf), helping in [discussions](https://github.com/py-pdf/pypdf/discussions), -and asking users who report issues for [MCVE](https://stackoverflow.com/help/minimal-reproducible-example)'s (Code + example PDF!). -The following is some of the most commonly asked questions: +and asking users who report issues for [MCVE](https://stackoverflow.com/help/minimal-reproducible-example)'s (Code + example PDF!). -**I get the following error message when I use the pypdf module: ImportError: No module named 'pyPDF'** - -To fix this issue, be sure that you are using the correct name when importing the module. The name of the module is pypdf. -Also, be sure you are using the correct version of pypdf. pypdf 3.1.0 and above are recommended. Use pypdf>=3.1.0 if the issue persists. - -**How can I use pypdf to merge pdf files?** - -Use the PdfMerger class. The append method is great for simply concatenating files, but merge can be used -for more precise control. - -**How can I extract text from a pdf?** - -There are several ways of extracting text from a pdf file using pypdf. The extractText method is likely the simplest way of doing this. ### Issues