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.

Sign up for GitHub

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

Jump to bottom

DOC: How to cite PyPDF2 #1476

Merged
merged 7 commits into from Dec 10, 2022
Merged

DOC: How to cite PyPDF2 #1476

merged 7 commits into from Dec 10, 2022

Conversation

MartinThoma
Copy link
Member

Closes #1475

@MartinThoma MartinThoma mentioned this pull request Dec 8, 2022
Closed
@MartinThoma
Copy link
Member Author

@maphew @pubpub-zz @mstamy2 @exiledkingcc What do you think about this guide how to cite PyPDF2?

Examples for other software:

  • Numpy: A lot of people are mentioned, but by far not all. They wrote a white-paper
  • Scipy: They mention "SciPy 1.0 Contributors"
  • Tensorflow: A whitepaper on Zenodo
  • Lasagne

@pubpub-zz
Copy link
Collaborator

pubpub-zz commented Dec 8, 2022 •
edited

looks good. perhaps add also a link to the github contributors page to have a dynamic list of the contributors and be sure to not forget anyone

@MartinThoma
Copy link
Member Author

@pubpub-zz I've replaced the URL by the contributors page URL

and be sure to not forget anyone

The contributors page is for sure missing a lot of people. I will add the once which I perceive as the most important ones (the people who I have added as authors into bibtex directly - but even there I'm not sure if I might have forgotten people)

MasterOdin
MasterOdin reviewed Dec 9, 2022
View reviewed changes
Copy link
Member

@MasterOdin MasterOdin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My recommendation that if you wanted to make PyPDF2 citable, you should add it to zenodo. Having a permanent DOI that one can use to reference back to a work is nice for a number of reasons in my experience.

docs/meta/faq.md Outdated Show resolved Hide resolved
MartinThoma and others added 2 commits December 10, 2022 08:10
@MartinThoma @MasterOdin
Update docs/meta/faq.md
6e8fcf6 
Co-authored-by: Matthew Peveler <matt.peveler@gmail.com>
@MartinThoma
Merge branch 'main' into cite-pypdf2
364d80f
@MartinThoma
Copy link
Member Author

you should add it to zenodo

I think that's a good idea. I'll do that once we merged back into pypdf

@MartinThoma
Copy link
Member Author

I'll merge this now. Feel free to add comments here / open issues. I'm open to adjust this :-)

@MartinThoma MartinThoma merged commit fe461a1 into main Dec 10, 2022
@MartinThoma MartinThoma deleted the cite-pypdf2 branch December 10, 2022 13:07
MartinThoma added a commit that referenced this pull request Dec 10, 2022
@MartinThoma
REL: 2.12.1
ce0e190 
Documentation (DOC)
-  Deduplicate extract_text docstring (#1485)
-  How to cite PyPDF2 (#1476)

Maintenance (MAINT)
  Consistency changes:
  -  indirect_ref/ido ➔ indirect_reference, dest➔ page_destination (#1467)
  -  owner_pwd/user_pwd ➔ owner_password/user_password (#1483)
  -  position ➜ page_number in Merger.merge (#1482)
  -  indirect_ref ➜ indirect_reference (#1484)

[Full Changelog](2.12.0...2.12.1)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MasterOdin MasterOdin MasterOdin left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Citation information for PyPDF2
3 participants
@MartinThoma @pubpub-zz @MasterOdin