Is the PyGithub project dead? How can the community help?

EnricoMi commented 2 years ago

Over the last months, I have seen many very good pull requests from the community that fix blocking bugs or add new features, as well as many questions around issues using this library. This project is actively being used by 25k (public) Github repositories.

Unfortunately, this projects seems to be under-equipped with active maintainers. While the MAINTAINERS file lists six maintainers, there is only one lonely soul left driving this project. Blocking issues are mounting, ready pull requests are not reviewed, approved or merged, users getting annoyed by the lack of response while Github API is actively developing away from this Python implementation.

This is not sustainable.

Everyone knows and appreciates that this is open-source software and maintainers are putting their free time into this project. But this is no excuse to not improve the situation.

How can the community help?

💡 I want to collect things that the community can do to revive this project. Please leave your ideas of supporting this project below.

Things the community can do:

try hard to minimize the time effort for maintainers:
- try to investigate the issues yourself, create bug fixes and pull requests
- try to do the same for other users that don't or can't do it
- review others' pull requests so that they are more likely to get approved
- answer other users' question
- ideally, maintainers only have to approve and merge pull requests, as well as cut releases or give broad guidance on design decisions
individuals backed by companies that use this Python package should consider to invest some of their work time in contributing back to this open-source software project
experienced users can help new users getting started
watch all activities:
support maintainer or contributors financially

Things maintainers can do:

make the base of maintainers broader, pass maintainer rights over to active contributors
delegate code reviews to community members that have contributed or code reviewed before
- invite them directly to specific issues or pull requests
get completed pull requests merged and released
focus on on-boarding new maintainers and code reviewers rather than fixing bugs

Who volunteers?

Please leave a comment below if you volunteer for any of these roles:

maintainer (a few hours per week would revive this project)
code reviewer
- get pull requests into a good shape so that maintainers have to spend less time and are more likely to approve
experienced user
- answer questions and resolve issues related to usage of the library, not bugs or new features

mcauley-penney commented 2 years ago

I'm a decently experienced user and I'd be willing to be assigned questions

theCapypara commented 2 years ago

Hi! I would also be ready to help, I'm not super familiar with this project yet, aside from some minor work for adding autolink references (#2016), but I would still like to help out however I can.

Can any of the active maintainers say something about the future of this project? Does Github itself have maybe in interest in helping maintaining this project?

EnricoMi commented 2 years ago

This project is so actively been used, so many questions, issues and open pull requests. But no attempt is done by the maintainers to open it up to the community.

MAINTAINERS, please mark this project as dead so the community is not wasting more time here.

Community, feel free to fork this repository, get all the good work merged and released there. Post your maintained fork here: https://github.com/PyGithub/PyGithub/discussions/2205

sfdye commented 2 years ago

Copying my answer from #2320

No, this project is not dead. Simply put, the maintainers are busy with their lives. If any of you want to get this project moving, consider joining the team or sponsoring via Github sponsors.

However I can get the PR review going when I have some free time towards the end of the year. In particular which ones would like to have first and released to PyPI? Let me know so I can prioritize.

EnricoMi commented 2 years ago

Lets use reactions on issue and pull request descriptions for prioritization

Here is a dashboard of top issues and PRs: #3050

The community should go to their most wanted pull requests and use the emoji button on the pull request description to add a :+1:: grafik grafik

lelegard commented 2 years ago

Hi @sfdye, following up on #2320,

No, this project is not dead. Simply put, the maintainers are busy with their lives. If any of you want to get this project moving, consider joining the team or sponsoring via Github sponsors.

As users of PyGithub, we are all Github users and, consequently, open source developers and we perfectly understand the dilemma between open source projects and life.

Joining the team definitely makes sense for those who are experienced Python developers. However, some users probably manage GitHub projects in another language and only have basic Python practice to write automation scripts, without the required Python track record to be accepted in the PyPI community. I consider myself as one of those.

Companies using professional GitHub accounts should definitely sponsor the project. Honestly, GitHub itself should sponsor or even take over the project. Your project is a support layer for their API, just like GitHub desktop, GitHub mobile app, GitHub CLI which are now maintained by GitHub.

sfdye commented 2 years ago

I will be on vacation from today, but before I go, let me kick off the cadence by fixing the failing CI in #2330. This should unblock the review of many PR because previously the CI failures are almost all related to the dependency issues which I have fixed now. Once you update your branch from master, your build should hopefully be green.

sfdye commented 2 years ago

Also I just released v1.56

trim21 commented 1 year ago

I'd like to become a maintainer to help review and merge pr

EnricoMi commented 1 year ago

@mcauley-penney @theCapypara please watch this project (at least issues and discussions), pick questions as you like:

See you around!

lucasgonze commented 1 year ago

I think the answer is that yes, it is dead. It is so dead that the founders can't be bothered to archive it or pass control to new maintainers.

I'm putting this in a comment to warn others who may be trying to figure this out. Woe is me. Do not do as I have done - scaffold a bunch of PyGithub code and then find out that it is way behind the actual API.

tomups commented 8 months ago

@lucasgonze I have seen @EnricoMi has released a new version 3 weeks ago. So not dead?

But @EnricoMi is the claim that PyGithub is way behind the actual github API warranted? I was planning to start using PyGithub in a new project.

EnricoMi commented 8 months ago

PyGithub is and always will be behind the Github API as (maybe countless) Github developers move the API forward and PyGithub follows. The speed to catch up is determined by 1) the community adopting features 2) maintainers reviewing, merging and releasing

Right now, PyGithub has only one active maintainer, so current pace could be improved by 1) having the community do more reviews to reduce effort for maintainers 2) volunteer as a maintainer to govern code quality, shape design and improve overall architecture

Dedicating one hour per day would greatly move this project forward, even one hour per week would be a boost.

devstein commented 6 months ago

If helpful, I built Dosu to help with community support on issues and discussion. It doesn't replace a maintainer though, only makes information more accessible to the community

PyGithub / PyGithub