fawkes/publish.sh at 5e9bef774d4e15527382ed3d556b1ba64205e8cc - fawkes - KSKA Git

ResearchPapers/fawkes

mirror of https://github.com/Shawn-Shan/fawkes.git synced 2025-02-24 00:57:06 +05:30

John Pulford 5e9bef774d Situation: Fawkes is a brilliant research project. I personally enjoyed reading the research paper. However, numerous issues and pull requests have resulted from how difficult it is to run after initially downloading it due to poorly documented python version requirements and compatibility collapse with numerous dependencies following ~4 years of drift. Example links in the last paragraph for brevity.

Action: I rewrote the setup code to depend on pyenv and poetry allowing us to explicitly require the use of python 3.9.0 rather than having users guess at how best to execute the code. I've used stricter dependency requirements (lots of ~= in pyproject.toml dependencies) as the project is unlikely to be maintained regularly and reviving the code required a lot of dependency incompatibility navigation we should avoid for future users.

Result: A new user can build this great research project with ~10 lines! A big win in my opinion.

Some relevant pull requests and issues.
https://github.com/Shawn-Shan/fawkes/pull/168
https://github.com/Shawn-Shan/fawkes/pull/158
https://github.com/Shawn-Shan/fawkes/issues/186
https://github.com/Shawn-Shan/fawkes/issues/178

2025-02-08 22:36:57 +00:00

11 lines

186 B

Bash

Raw Blame History

 #!/bin/bash
 # Publish the package
 poetry publish --build
 # Get the current version
 VERSION=$(poetry version -s)
 # Create and push a Git tag
 git tag v$VERSION
 git push origin v$VERSION