Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: add mention of crypto extra_requires for install #1017

Merged
merged 1 commit into from
Jun 22, 2022
Merged

Conversation

MasterOdin
Copy link
Member

This PR updates the docs to make mention of the PyPDF2[crypto] extras package when interacting with AES encrypted PDFs.

@MartinThoma MartinThoma merged commit 5834669 into main Jun 22, 2022
@MartinThoma MartinThoma deleted the crypto-docs branch June 22, 2022 05:24
@MartinThoma
Copy link
Member

Thank you very much 🤗 Good that you've added it - before, it was pretty hard for users to discover.

@MartinThoma
Copy link
Member

Should we add a hint to the README as well?

@MasterOdin
Copy link
Member Author

The README and the installation page in the docs have the same block describing installing PyPDF2[crypto], unless you meant adding something additional?

@MartinThoma
Copy link
Member

You're right, I forgot about that. It's exactly how I wanted it 😅 🙈

@pubpub-zz
Copy link
Collaborator

What about having a warning during pip install to indicate limitation if crypto is not installed?

@MartinThoma
Copy link
Member

That might not be so easy: https://stackoverflow.com/a/44617404/562769

MartinThoma added a commit that referenced this pull request Jun 26, 2022
New Features (ENH):
-  Support R6 decrypting (#1015)
-  Add PdfReader.pdf_header (#1013)

Performance Improvements (PI):
-  Remove ord_ calls (#1014)

Bug Fixes (BUG):
-  Fix missing page for bookmark (#1016)

Robustness (ROB):
-  Deal with invalid Destinations (#1028)

Documentation (DOC):
-  get_form_text_fields does not extract dropdown data (#1029)
-  Adjust PdfWriter.add_uri docstring
-  Mention crypto extra_requires for installation (#1017)

Developer Experience (DEV):
-  Use /n line endings everywhere (#1027)
-  Adjust string formatting to be able to use mutmut (#1020)
-  Update Bug report template

Full Changelog: 2.3.1...2.4.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants