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