Add frequently asked questions
parent
bbc01f749a
commit
14cc66ae6d
|
@ -0,0 +1,43 @@
|
|||
.. _fac:
|
||||
|
||||
Frequently asked questions
|
||||
**************************
|
||||
|
||||
Why is it called pdfminer.six?
|
||||
==============================
|
||||
|
||||
Pdfminer.six is a for of the `original pdfminer created by Euske
|
||||
<https://github.com/euske>`_. Almost all of the code and architecture is in
|
||||
fact created by Euske. But, for a long time this original pdfminer did not
|
||||
support Python 3. Untill 2020 the original pdfminer only supported Python 2.
|
||||
|
||||
Pdfminer.six started as a for of the original pdfminer with the goal of adding
|
||||
support for Python 3. This was done with the six package. The six package helps
|
||||
to write code that is compatible with both Python 2 and Python 3. Hence,
|
||||
pdfminer.six.
|
||||
|
||||
As of 2020, pdfminer.six dropped the support for Python 2 because it was
|
||||
`end-of-live <https://www.python.org/doc/sunset-python-2/>`_. While the .six
|
||||
part is no longer applicable, we kept the name to prevent breaking changes for
|
||||
existing users.
|
||||
|
||||
The current punchline "We fathom PDF" is a `whimsical reference
|
||||
<https://github.com/pdfminer/pdfminer.six/issues/197#issuecomment-655091942>`_
|
||||
to the six. Fathom means both deeply understanding something, and a fathom is
|
||||
also equal to six feet.
|
||||
|
||||
How does pdfminer.six compare to other forks of pdfminer?
|
||||
==========================================================
|
||||
|
||||
Pdfminer.six is now an independent and community maintained package for
|
||||
extracting text from PDF's with Python. We actively fix bugs (also for PDF's
|
||||
that don't strictly follow the PDF Reference), add new features and improve
|
||||
the usability of pdfminer.six. This community separates pdfminer.six from the
|
||||
other forks of the original pdfminer. PDF as a format is very diverse and
|
||||
there are countless deviations from the official format. The only way to
|
||||
support all the PDF's out there is to have a community that actively uses and
|
||||
improves pdfminer.
|
||||
|
||||
Since 2020, the original pdfminer is `dormant
|
||||
<https://github.com/euske/pdfminer#pdfminer>`_, and pdfminer.six is the
|
||||
recommended by Euske if you need an actively maintained version of pdfminer.
|
|
@ -39,6 +39,7 @@ pdfminer.six.
|
|||
howto/index
|
||||
topic/index
|
||||
reference/index
|
||||
faq
|
||||
|
||||
|
||||
Features
|
||||
|
|
|
@ -26,3 +26,5 @@ extract_pages
|
|||
|
||||
.. currentmodule:: pdfminer.high_level
|
||||
.. autofunction:: extract_pages
|
||||
|
||||
.. _api_extract_pages:
|
Loading…
Reference in New Issue