Ravenports generated: 13 Dec 2023 22:49
[ravenports.git] / bucket_F6 / python-PyPDF2
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-PyPDF2
4 VERSION=                3.0.1
5 KEYWORDS=               python
6 VARIANTS=               v11 v12
7 SDESC[v11]=             Pure Python PDF Toolkit (3.11)
8 SDESC[v12]=             Pure Python PDF Toolkit (3.12)
9 HOMEPAGE=               none
10 CONTACT=                Python_Automaton[python@ironwolf.systems]
11
12 DOWNLOAD_GROUPS=        main
13 SITES[main]=            PYPIWHL/8e/5e/c86a5643653825d3c913719e788e41386bee415c2b87b4f955432f2de6b2
14 DISTFILE[1]=            pypdf2-3.0.1-py3-none-any.whl:main
15 DF_INDEX=               1
16 SPKGS[v11]=             single
17 SPKGS[v12]=             single
18
19 OPTIONS_AVAILABLE=      PY311 PY312
20 OPTIONS_STANDARD=       none
21 VOPTS[v11]=             PY311=ON PY312=OFF
22 VOPTS[v12]=             PY311=OFF PY312=ON
23
24 USES=                   cpe
25
26 DISTNAME=               pypdf2-3.0.1.dist-info
27
28 CPE_PRODUCT=            pypdf2
29 CPE_VENDOR=             pypdf2_project
30 GENERATED=              yes
31
32 [PY311].USES_ON=                        python:v11,wheel
33
34 [PY312].USES_ON=                        python:v12,wheel
35
36 [FILE:2550:descriptions/desc.single]
37 [PyPI version]
38 [Python Support]
39 [![]](https://pypdf2.readthedocs.io/en/stable/)
40 [GitHub last commit]
41 [codecov]
42
43 # **NOTE**: The PyPDF2 project is going back to its roots. PyPDF2==3.0.X
44 will be  the last version of PyPDF2. Development will continue with
45 [`pypdf==3.1.0`].
46
47 # PyPDF2
48
49 PyPDF2 is a free and open-source pure-python PDF library capable of
50 splitting,
51 [merging],
52 [cropping, and transforming]
53 the pages of PDF files. It can also add
54 custom data, viewing options, and
55 [passwords]
56 to PDF files. PyPDF2 can
57 [retrieve text]
58 and
59 [metadata]
60 from PDFs as well.
61
62 ## Installation
63
64 You can install PyPDF2 via pip:
65
66 `
67 pip install PyPDF2
68 `
69
70 If you plan to use PyPDF2 for encrypting or decrypting PDFs that use AES,
71 you
72 will need to install some extra dependencies. Encryption using RC4 is
73 supported
74 using the regular installation.
75
76 ```
77 pip install PyPDF2[crypto]
78 ```
79
80 ## Usage
81
82 ```python
83 from PyPDF2 import PdfReader
84
85 reader = PdfReader("example.pdf")
86 number_of_pages = len(reader.pages)
87 page = reader.pages[0]
88 text = page.extract_text()
89 ```
90
91 PyPDF2 can do a lot more, e.g. splitting, merging, reading and creating
92 annotations, decrypting and encrypting, and more.
93
94 Please see [the documentation]
95 for more usage examples!
96
97 A lot of questions are asked and answered
98 [on StackOverflow].
99
100 ## Contributions
101
102 Maintaining PyPDF2 is a collaborative effort. You can support PyPDF2 by
103 writing
104 documentation, helping to narrow down issues, and adding code.
105
106 ### Q&A
107
108 The experience PyPDF2 users have covers the whole range from beginners who
109 want to make their live easier to experts who developed software before PDF
110 existed. You can contribute to the PyPDF2 community by answering questions
111 on [StackOverflow],
112 helping in [discussions],
113 and asking users who report issues for [MCVE]'s (Code + example PDF!).
114
115 ### Issues
116
117 A good bug ticket includes a MCVE - a minimal complete verifiable example.
118 For PyPDF2, this means that you must upload a PDF that causes the bug to
119 occur
120 as well as the code you're executing with all of the output. Use
121 `print(PyPDF2.__version__)` to tell us which version you're using.
122
123 ### Code
124
125 All code contributions are welcome, but smaller ones have a better chance
126 to
127 get included in a timely manner. Adding unit tests for new features or test
128 cases for bugs you've fixed help us to ensure that the Pull Request (PR) is
129 fine.
130
131 PyPDF2 includes a test suite which can be executed with `pytest`:
132
133 ```bash
134 $ pytest
135 ===================== test session starts =====================
136 platform linux -- Python 3.6.15, pytest-7.0.1, pluggy-1.0.0
137
138
139 [FILE:108:distinfo]
140 d16e4205cfee272fbdc0568b68d82be796540b1537508cef59388f839c191928       232572 pypdf2-3.0.1-py3-none-any.whl
141