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

Is this project dead / abandoned ?? #600

Closed
AmmarHaddadi opened this issue Jul 23, 2022 · 28 comments
Closed

Is this project dead / abandoned ?? #600

AmmarHaddadi opened this issue Jul 23, 2022 · 28 comments
Labels

Comments

@AmmarHaddadi
Copy link

The owner is not updating the files even if people are still pushing good edits

@ChrisKnott
Copy link
Collaborator

ChrisKnott commented Jul 23, 2022 via email

@manecosta
Copy link

I just found out about eel a couple of days ago and it's by far one of the most useful projects I've seen in a while.
It is is too good of an idea to allow it to die. I really hope there's someone with enough knowledge on it that can keep moving it forward. I also hope your life changes in a positive way that allows you to dedicate some time to it again.

In the meantime, I'll keep experimenting with it and if I ever feel like I'm in a good position to lend a hand, I'll definitely propose myself. To everyone in the community that has a good grasp on it and has the will and time to devote, please do consider becoming a maintainer!

@dstricks
Copy link
Contributor

I really like Eel and don't want to see it officially abandoned. I can help out on a limited basis. My only request is that @ChrisKnott provisionally agree to either a) package up and deploy out new releases to PyPI with new contributions I assist with OR b) eventually give me the permissions to do so. I wouldn't want any invested time to go to waste if no new releases are pushed out to the community.

If any bona fides are desired... I've answered several Eel tagged questions on Stack Overflow (https://stackoverflow.com/search?q=user:464504+eel&s=3c4736c0-4565-4005-b5e9-6b4e0024ceff). And I've been a full-time Python developer for many years (https://www.linkedin.com/in/dstricks).

@dardevelin
Copy link

dardevelin commented Aug 22, 2022 via email

@dstricks
Copy link
Contributor

I think becoming a maintainer of a branch at first and ramping up would be
a good way to get the ball rolling.

TBH, I don't care about the mechanics of how the code gets released, only that someone agrees to release it. I'd be fine submitting PR's like the rest of the general public and not even having commit access so long as someone is there to merge and release. That's my main concern... doing things that nobody will use.

Python is great that you can easily use a repo in pip pointing to a branch
release.

Pip is versatile for sure. If people are willing to install an unofficial version, then they could clone the code, make whatever updates they wanted, and then pip install <path-to-your-version> and they'd be good to go. Or install a fork (there are 500+ of them). But IMHO these options don't support the larger community... 50K downloads last month alone per https://pypistats.org/packages/eel.

@samuelhwilliams
Copy link
Collaborator

Hey @dstricks - just heard from Chris that you've offered to pick up maintaining Eel which is super exciting, thanks! Like Chris I feel bad seeing how active the community still is despite our lack of time to maintain the repo.

Happy to have a chat and hopefully get you setup and in a place where you can maintain Eel and release new versions :)

@dstricks
Copy link
Contributor

Heya @samuelhwilliams, yeah it's true! Chris made me a collaborator recently and I've been trying to get up to speed. I'd appreciate any handover tips or advice you're willing to give. I'm very familiar with Python, but not so much maintaining open source on GitHub or publishing to PyPI, so that's where guidance would be very useful. I can be reached at [email protected] or more recently dstricks#0510 on Discord.

At a minimum, I think either you or @ChrisKnott will need to add me to the PyPI project for when a new release is built and ready to be distributed. That may be a little while depending on how much I want to try to fit into a v0.15.0. Anyway, any guidance would be much appreciated. Cheers!

@ChrisKnott
Copy link
Collaborator

@dstricks Yep I will add you to PyPI and also transfer ownership of the repo (unless you think it's better to set up an "organisation" account?). Beware that you will probably start getting automated hacking attempts on your account so maybe set up 2FA or at least pick a strong password!

@dstricks
Copy link
Contributor

I will add you to PyPI and also transfer ownership of the repo (unless you think it's better to set up an "organisation" account?).

I'm fine with taking ownership. To be honest... whatever is easiest for you so long as I can publish :)

Beware that you will probably start getting automated hacking attempts on your account so maybe set up 2FA or at least pick a strong password!

I think I have 2FA enabled, but I'll double-check that now! Thanks for the tip.

@samuelhwilliams
Copy link
Collaborator

samuelhwilliams commented Sep 29, 2022

You shouldn't need to be added to PyPi immediately or do anything custom - when you want to release a new version, run the 'Publish' github action in this repo and it should go straight out.

We can get you switched over on there eventually but it's not something that needs to happen immediately :)

@samuelhwilliams
Copy link
Collaborator

@dstricks Sounds exciting that you have lots planned for v0.15.0, but I would definitely recommend taking it slow in the beginning and publishing smaller more incremental updates just while you get your head around things - eg to get familiar with the publishing/versioning process, etc. Priority should obviously be to not break anything and to keep broadly following semver, ie don't mess too much with backwards compatibility without going to v1 (although v0.x generally doesn't indicate API stability, it's still nice to not mess around too much obviously).

@dstricks
Copy link
Contributor

when you want to release a new version, run the 'Publish' github action in this repo and it should go straight out.

@samuelhwilliams That sounds brilliant! I see the Publish workflow, along with the previous runs that were successful for v0.14.0 and below, but there's no "Run Workflow" button for me that most github guidance suggests should be there. I'll keep poking around, but do you know if there are any permissions or similar that would need to be tweaked to enable that for me? It could totally be my lack of understanding of how these things work... there are so many bells and whistles enabled now :)

@netesy
Copy link

netesy commented Sep 30, 2022

I believe an organisation account would be better.

@samuelhwilliams
Copy link
Collaborator

@netesy this is something @ChrisKnott and I were just discussing - yes, it may be.

@dstricks
Copy link
Contributor

dstricks commented Oct 1, 2022

@ChrisKnott and @samuelhwilliams Could you kindly allow me to push to master OR alternatively provide Reviews on my PR's when they become stale after a few days? (I can add you guys as reviewers when they've been lingering for a few days).

One day I hope to have everything Reviewed by the community, but I don't think it's active enough yet. I've been waiting and hoping that someone would provide a review to #612 which was submitted two weeks ago, but no luck. And I just submitted another one with #616.

Let me know your thoughts on how to proceed in a safe but "less painful" manner.

Sounds exciting that you have lots planned for v0.15.0

Not at all :)

I'm super cautious. My only plan right now is to update all the core dependencies and try to add support and testing for 3.9 and 3.10. That'll most likely be reviewing #558. I might also pick up a few other items that looks straightforward and would be typical "first-time contributor" level things.

@ChrisKnott
Copy link
Collaborator

Yes I'm fine with that, can't find where the option is though...?

@samuelhwilliams
Copy link
Collaborator

@dstricks one thing I'd suggest is not pushing to master directly (as standard). Work on branches, push up a branch, make a PR, and merge it from there. Even if you're not getting review/approval from another developer it's good in terms of transparency, letting others see what features are coming in and why, and keeping changes self-contained.

It's a good habit to get in for open source projects, and I'd suggest only breaking this in absolute emergencies (of which I can't think of many, really).

Feel free to tag me in a couple of PRs but can't promise too much time. If I haven't reviewed within a couple of days (Mon-Fri), I'd say probably just go ahead on your own 👍

@samuelhwilliams
Copy link
Collaborator

@dstricks I made a mistake when talking about how to publish new versions of Eel to PyPi. The workflow is set up to automatically publish when a release is made on GitHub. You can hopefully do that (now) from this page: https://github.com/python-eel/Eel/releases

Click 'Draft new release', then 'Choose a tag' and enter a new tag for the version (in format vX.Y.Z). Give the release a title and a description of the changes, then click Publish release. After doing that the Publish workflow will automatically kick off. Make sure that you've updated setup.py's version= to the matching version number first, and added an entry to the changelog (probably the same as the GitHub release description).

@dstricks
Copy link
Contributor

dstricks commented Oct 1, 2022

Work on branches, push up a branch, make a PR, and merge it from there. Even if you're not getting review/approval from another developer it's good in terms of transparency, letting others see what features are coming in and why, and keeping changes self-contained.

That works for me. It could be my lack of understanding of how GitHub works, but I'm neither able to add a Review to my own PR nor merge a PR without 1 approved Review. So they get stuck :)

Long term if we can get active community support, then I don't want to merge any PR (even my own) without an approval. But I think it will take time for that to build.

you can hopefully do that (now) from this page

I'll check and confirm. Thanks for the update!

@samuelhwilliams
Copy link
Collaborator

samuelhwilliams commented Oct 1, 2022

That works for me. It could be my lack of understanding of how GitHub works, but I'm neither able to add a Review to my own PR nor merge a PR without 1 approved Review. So they get stuck :)

This was the case but shouldn't be any longer - I've disabled the "require approvals before merge" option :) You're right though: you can't post a review of your own PR (GitHub doesn't allow it).

It's definitely still nice to get reviews where possible though - but no longer blocking you if Chris or I aren't available.

@netesy
Copy link

netesy commented Oct 3, 2022

I will be willing to contribute in anyway possible. Right now i am thinking about writing user tutorials/documentation for new users.

@dstricks
Copy link
Contributor

dstricks commented Oct 8, 2022

I will be willing to contribute in anyway possible. Right now i am thinking about writing user tutorials/documentation for new users.

Nice, thanks @netesy. There are several "how can I..." type questions in the issues that could use attention, so that help would be much appreciated!

You can hopefully do that (now) from this page

I'm able to open the 'Draft a new release' page, so I assume so. We'll find out whenever I try to release :-)

I believe an organisation account would be better.

An organisation was formed!!!

@ChrisKnott and @samuelhwilliams IMHO the formation of the Python Eel organisation deserves an issue announcement. It shows the project is taking steps towards building a sustainable and collectively managed future and plans to be around long-term. I can make such an announcement if you think it's warranted but you don't have the time.

A few related questions:

  • Should we update the setup.py to have Python Eel information as author?
  • Same question as above but for author_email (if there a Python Eel email address that can be used)?
  • What's your vision for the Python Eel organisation? I know the immediate term is to house Eel, but longer term do you have plans?

@samuelhwilliams
Copy link
Collaborator

samuelhwilliams commented Oct 10, 2022

I can make such an announcement if you think it's warranted but you don't have the time.

By all means 👍

Should we update the setup.py to have Python Eel information as author?
Same question as above but for author_email (if there a Python Eel email address that can be used)?

Sounds like a good idea, yeah 👍

What's your vision for the Python Eel organisation? I know the immediate term is to house Eel, but longer term do you have plans?

Broadly we've just formed the organisation in order to facilitate cleaner lines of management for Eel - so it's mostly an operational decision rather than one made with strategic goals in mind. I would be inclined to say that the community (including you as a new maintainer) should decide on the way forward, particularly as Chris and I haven't had the time to put towards setting these long-term goals and it's likely that any contribution or involvement we have in the near future will be fairly ad-hoc.

@dstricks
Copy link
Contributor

dstricks commented Oct 17, 2022

Sounds like a good idea, yeah 👍

@samuelhwilliams Did you create and/or register an organisation email that can be used in setup.py?

@samuelhwilliams
Copy link
Collaborator

@dstricks I haven't done that no - probably don't have a good option. Think we just make a gmail/protonmail account for it maybe?

@dstricks
Copy link
Contributor

Think we just make a gmail/protonmail account for it maybe?

Yeah, good. If you want to set that up then just let me know the address. Or I can create it later this week and share the credentials with you and Chris. I have Chris' email because it was posted on PyPI, but I don't have yours. Mine is dstricks (at) Gmail if you want to reach out with yours.

I think it's time to close this issue :)

@DvScripts
Copy link

Think we just make a gmail/protonmail account for it maybe?

Yeah, good. If you want to set that up then just let me know the address. Or I can create it later this week and share the credentials with you and Chris. I have Chris' email because it was posted on PyPI, but I don't have yours. Mine is dstricks (at) Gmail if you want to reach out with yours.

I think it's time to close this issue :)

Maybe make official discord server to help people? ;-) and they could share ideas etc

@dstricks
Copy link
Contributor

dstricks commented Dec 9, 2022

Hi @DvScripts, thanks for the suggestion. We do have one... here is an invite: https://discord.com/invite/3nqXPFX

The link is also in the project's README, but maybe not easy to quickly see.... might have to look into making it more prominent.

@python-eel python-eel locked as resolved and limited conversation to collaborators Dec 9, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

8 participants