Make it more useable out of the box

[lrq3000]

Awesome idea and project, thank you very much for sharing your work!

I stumbled by chance on it, and even though I am not working in video compositing, I am an experienced Python developer, so I thought I would help in making this app more useable out of the box for others.

Here are the changes:

• Modernize packaging to PEP517 standard (build isolation, build requirements, dependencies specified in the same file, pyprojects.toml).
• Add a videogestalt binary script entry that is installed in the local environment.
• Allow to specify output as an argument.
• Can be used as a Python module too.
• Minor documentation improvements: added a Description section, a License section, and embedded the example image (future-proofing).

The app is ready to be deployed, with python -sBm build . and then twine dist/.

Also if you would be open to having a maintainer, I would be happy to maintain the project. I am very unlikely to add new core features, but I can manage PRs, bugfixes and deployment. I can for example automate deployment to PyPi with an automated test deployment on TestPyPi using a GitHub Action, when a GitHub Release is created, as I did in my other projects.

[lrq3000]

PS: The app works on Windows too, so it likely works on MacOS too.

[lrq3000]

@eobrain Did you have some time to have a look at this PR? FYI, anyone can create any repository on PyPi with any name, so anybody can create a videogestalt repository right now. If you want and don't have time to manage this repo right now, I can book videogestalt in the PyPi repository for you and transfer rights to you when you will have a pypi account.

It's just that your app is so amazing and the name so perfectly representing what the tool does that I think it would be a shame if we get scooped the PyPi repo name :-)

[eobrain]

Hey, this is great! I just reviewed the code diffs and they look good. I'm going to just test in the branch before I merge.

And it looks like you would be a good maintainer. I'll add you after I do the merge.

And feel free to go ahead and book videogestalt in the the PyPi repository repo. Thanks.

[lrq3000]

Awesome, thank you very much for considering my suggestions and for reviewing my pr! I'll book in a few hours as soon as I get access to my computer :-) 7 mai 2023 02:17:15 eobrain ***@***.***>:

…

Hey, this is great! I just reviewed the code diffs and they look good. I'm going to just test in the branch before I merge. And it looks like you would be a good maintainer. I'll add you after I do the merge. And feel free to go ahead and book *videogestalt* in the the PyPi repository repo. Thanks. — Reply to this email directly, view it on GitHub[#1 (comment)], or unsubscribe[https://github.com/notifications/unsubscribe-auth/AAIRFXXYOMWTBUKGSHCWZ7DXE3SYXANCNFSM6AAAAAAXSL4A4Q]. You are receiving this because you authored the thread.[Image de pistage][https://github.com/notifications/beacon/AAIRFXU2OIOUY42MQFXDR2LXE3SYXA5CNFSM6AAAAAAXSL4A4SWGG33NNVSW45C7OR4XAZNMJFZXG5LFINXW23LFNZ2KUY3PNVWWK3TUL5UWJTS3UCK3G.gif]

[eobrain]

Is there a particular reason for pulling the example GIF output into the repo? If not, I suggest leaving it in its original position in GitHib static images.

[lrq3000]

Yes usually when an image is meant to be included in the README and not just in the static website, I prefer to include them in the repository to be more future proof, as URLs of static sites may change or be down at any point in the future (it already happened in the past). There is also another pragmatic reason, it's because I don't know where the image is stored currently (I cannot find the source branch from which the image is pushed to GitHub pages?).

[eobrain]

For me (using Python 3.9.2 on Linux) this failed with

ERROR: File "setup.py" not found. Directory cannot be installed in editable mode: /home/eobrain/src/lrq3000
(A "pyproject.toml" file was found, but editable mode currently requires a setup.py based build.)

[lrq3000]

Mmmm I guess your pip version is not updated to the latest, as it should be fixed since pip versions of last year. Nevertheless, I have implemented a workaround now, please retry with my updated PR and let me know if this works :-)

[eobrain]

Suggest adding the commands to run the videogestalt command from the local development version

[lrq3000]

Apart from the git cloning, this is the only command that should be needed. Now that I fixed the ERROR: File "setup.py" not found, this should work as expected :-)

[lrq3000]

Ok I have worked some more on the potential retrocompatibility issues with the modern python packaging standards, and I also added a simple unit test that will need to be improved later to be more robust but it will do for now :-)

At this point the package should be ironed out, please let me know if it installs fine for you too :-)

[lrq3000]

Thank you @eobrain for the fast review and merge, and for adding me as a maintainer! I'm going to setup continuous integration and deployment asap :-)

[lrq3000]

Also I will make the first PyPi release after all tests pass, unless you want me to postpone the release :-)

[eobrain]

Welcome! And thanks for making this project so much better

Yes, please go ahead and make a PyPi release

[lrq3000]

@eobrain You are very welcome, the new Python packaging system is marvelous but it has a bit of a learning curve, I'm very happy to help :-)

I'm sorry, I will need a bit more of your help :-/ I don't have access to the repository settings, so I can't create environment secrets, such as for coverage and automated PyPi upload, you will either need to add them yourself (I can give you the instructions or even the tokens directly by e-mail), or give me additional permissions. If the latter, I never did so myself, but the author of another repository recently did it for me and told me he had to make the project into an organization first to be able to make me an admin.

Please let me know what you prefer and I'll help the best I can :-)

[lrq3000]

Let's discuss in #3 (PR to prepare for the first release) for the rest :-)