Plans for fpdf2 to join the py-pdf org #752
Replies: 9 comments 20 replies
-
Correct, due to https://github.com/PyFPDF/fpdf2/blob/master/.github/workflows/continuous-integration-workflow.yml#L89-L101 Please note that this does not give anybody else access to PyPI. The current owners within PyPI still stay the (only) owners. Meaning if one of the GitHub py-pdf admins went evil / leaked their credentials, it would be possible to clean up the mess. Let's hope that never happens though 🤞 |
Beta Was this translation helpful? Give feedback.
-
|
@Lucas-C By the way, that might actually be something that pypdf would take over from fpdf2 :-) I was hesitant to give anything / anybody else access to PyPI for security concerns. However, I now understand better how it works and I think I would notice malicious uploads + GitHub is mostly trustworthy (errors happen, though) |
Beta Was this translation helpful? Give feedback.
-
|
Thank You @Lucas-C for tagging.
Out of curiosity, what will be the advantages of moving |
Beta Was this translation helpful? Give feedback.
-
It actually may. If I'm looking at packages from different sources, then the probability of me looking deeper in the documentation for a "related" list is definitively there. I remember finding fpdf2 that way when looking for a tool less than two years ago, and it was a distinctly non-trivial search. But when several tools are homed under a common roof, then I expect to find a list of their different purposes/target audiences/other distinctions right at the top. And since several of the packages have a rather complex genealogy, info should also be included as to which other (possibly outdated/obsolete) packages they are meant to replace. This kind of information is simply good "customer service", and to some degree "marketing". You want to make it as easy as possible for prospective users to find the right tool for their task. |
Beta Was this translation helpful? Give feedback.
-
I agree overall 😊 Would you want to contribute some documentation toward this valuable goal @gmischler? |
Beta Was this translation helpful? Give feedback.
-
At some point (after the move), having the goals and target audiences of the various projects clearly stated may also help in deciding the future development direction of each of them, or a potential common core library. Maybe in the future, some thought could also be invested in finding more memorable and distinguishable project names. Or am I the only one who keeps getting confused by names in the form of
I'm not particularly familiar with most of the projects involved, let alone their history. I just couldn't help but notice that there is a lot of "heritage" all around. Descriptions of the distinguishing characteristics should probably rather be crafted by people intimately familiar with each individual project. |
Beta Was this translation helpful? Give feedback.
-
|
Here are some pages that compare the different projects:
We should probably make one page about the Python / PDF ecosystem on https://py-pdf.github.io/. Then our projects can link to that page. |
Beta Was this translation helpful? Give feedback.
-
That is a complicated discussion for existing projects. The decision here should only be at the project maintainers, not in the py-pdf organization. Besides that: I completely agree! At least for pypdf I hope it's simple now: All lowercase, no numbers. But moving the project is a major step. I wouldn't want to do it again for pypdf. I would recommend to keep the following consistent and always make all-lowercase names:
|
Beta Was this translation helpful? Give feedback.
-
|
As long as the fpdf2 project can keep it's characteristics of being welcoming and encouraging new contributors, I don't see a problem. |
Beta Was this translation helpful? Give feedback.
-
|
@andersonhc Correct. I also feel the same. Contributing to this project feels easy from some other projects that I explored. |
Beta Was this translation helpful? Give feedback.
-
|
Thank you for your kind words @andersonhc & @ssavi-ict 😊 |
Beta Was this translation helpful? Give feedback.
-
|
I can only agree with the previous speakers. After a long search (because it is really opaque with these pdf libraries) I stumbled upon this repo and am happy to have found it. You take good care of it and I really hope that after a possible transfer it will continue. |
Beta Was this translation helpful? Give feedback.
-
|
@Lucas-C , first of all thanks for all the work you have been putting in. Maintaining a package like fpdf2 on your own is fun and rewarding but can easily become a burden and a responsibility. I think it is good that you found a way to share this with multiple people. Although shared responsibility is no responsibility and when creating something is it often easier to be able to dictate rather than having to get approval from others. For users like me the combination of fpdf2 and pypdf is great as I'm using both of them together: fpdf2 to export some chapters and pypdf to mix in drawings (from autocad and such) and appendices. Having both the tools supported by the same people would be a good thing. Next step could be merging/refactoring the packages such that they use common resources from the same pool. Logical candidates would be test-files, CI, testing and documentation. TLDR: YES :-) |
Beta Was this translation helpful? Give feedback.
-
|
Ownership of the py-pdf organization is another important aspect. I want to make @Lucas-C an owner, but I also want the community to participate in the discussion. I've linked it already for the pypdf / PyPDF2 people, but maybe you're interested as well: py-pdf/py-pdf.github.io#3 :-) |
Beta Was this translation helpful? Give feedback.
-
|
Btw: Kind of funny in this context that fpdf2 is not even mentioned (yet) on awsome-pdf... 🤨 |
Beta Was this translation helpful? Give feedback.
-
|
I've added it 😄 By the way: Anybody can add PRs there ... or open an issue. It was coincidence that I've seen your comment here. |
Beta Was this translation helpful? Give feedback.
-
|
As a side-note: We now use fpdf2 in I want to extend this kind of usage in future :-) |
Beta Was this translation helpful? Give feedback.
-
|
Nice! Regarding this topic of moving |
Beta Was this translation helpful? Give feedback.
-
|
thanks for letting me know - I didn't see that PR 🙈 I moved in the middle of May and missed a couple of things during that time 😅 |
Beta Was this translation helpful? Give feedback.
-
|
I have just moved |
Beta Was this translation helpful? Give feedback.
-
|
The PyFPDF GitHub organization is now archived: https://github.com/PyFPDF And I have setup a redirection from https://pyfpdf.github.io/fpdf2/ to https://py-pdf.github.io/fpdf2/, |
Beta Was this translation helpful? Give feedback.
-
|
I need Help in Header where i want the header text to be in all pages and the header text changes dynamically in some pages is this possible |
Beta Was this translation helpful? Give feedback.
-
|
@ramanasai, please open a new thread for your question. You are completely off-topic in this specific discussion here. |
Beta Was this translation helpful? Give feedback.
-
|
Yes, I second @gmischler answer. Please also take care to provide some code demonstrating what your are trying to achieve, |
Beta Was this translation helpful? Give feedback.
-
Hi users of
fpdf2! 😊I am the current maintainer of
fpdf2.I started contributing PRs to this project during the summer of 2020.
At the time, @alexanderankin who created this fork of PyFPDF, was the maintainer.
Since then, he handed over maintainership to me,
fpdf2evolved significantly, and I am quite proud of its current set of features, its stability and its performances (even if there is always room for improvements 😄).And this was only possible thanks to the numerous, generous and skilled
fpdf2contributors: https://github.com/PyFPDF/fpdf2#contributors-Many thanks to you all! 👍🙏
However, I have been the only active maintainer for more than a year now, answering issues and making or reviewing Pull Requests.
While considering the future of
fpdf2, and the possibility that I will have less time to dedicate to this project at some point,I have been considering how to share the ownership of
fpdf2with other benevolant developpers for several months now.Last week, a discussion popped up in @sarnold fork of @pmaupin great pdfrw library, about how to maintain this fork and share ownership: sarnold/pdfrw#15. One idea was to move this fork to the @py-pdf GitHub org, managed by @MasterOdin & @MartinThoma, who maintain https://github.com/py-pdf/pypdf, the successor of
PyPDF2.At the same time, @reingart reached out to me & @MartinThoma by email about archiving or handing over https://github.com/reingart/pyfpdf.
Given this context, and the presence of some motivated Python developpers willing to share efforts to maintain libraries dedicated to parsing & building PDF documents, I think this is the right opportunity to join forces!
Hence this discussion, that aims to present my current plans for the future of
fpdf2and get feedback from you, thefpdf2community 😊✅ Step 1 - Establish some basic guidelines for maintainers of the py-pdf org
The goal is to establish some basic principles for maintainers to work together & help each other.
For now I have mostly in mind some basic rules on how to manage releases ("when ?" & "how ?", for example fpdf2 has a checklist), and how people can can become maintainers For example, does it require explicit approval of all existing maintainers?
Basically, I initially just want to limit the risk of "broken"
fpdf2releases being made an impacting users.Those guidelines could then evolve over time.
I'm planning to submit a first draft as an issue of https://github.com/py-pdf/py-pdf.github.io for @MasterOdin & @MartinThoma to review it, and to take inspiration from the following existing guidelines / group of maintainers:
✅ Step 2 - Move fpdf2 to https://github.com/py-pdf
This should be relatively straightforward, as GitHub makes this relatively easy:
https://docs.github.com/en/repositories/creating-and-managing-repositories/transferring-a-repository
At this point, all @py-pdf maintainers will be able to handle
fpdf2issues & PRs, and perform new releases of the library.Step 3 - Homogenization
Personnally, I'd like to contribute to https://github.com/py-pdf/pypdf (and https://github.com/sarnold/pdfrw if it joins @py-pdf) in order to discover & learn about how they manage things: code structure, linters, unit tests...
And in the end, I have the idea of sharing some practices toward static code analysis, tests & CI/CD pipelines between projects of the @py-pdf organization. To make things easier for @py-pdf maintainers and also because I like setting up this kind of stuff 😅
Community feedbacks
Do you have any questions regarding this plan?
I'd love to get your reactions! 😊
Ping to some major & recent contributors: @alexp1917, @gmischler, @eroux, @erap129, @Bubbu0129, @RedShy, @andersonhc, @RubendeBruin, @ssavi-ict
Beta Was this translation helpful? Give feedback.
All reactions