search

alan-turing-institute / ReadabiliPy

A simple HTML content extractor in Python. Can be run as a wrapper for Mozilla's Readability.js package or in pure-python mode.
MIT License
230 stars 36 forks source link

Move away from deprecated `setup.py install`, setup GHA #103

Closed nelson-liu closed 1 year ago

nelson-liu commented 1 year ago

Continuation of https://github.com/alan-turing-institute/ReadabiliPy/pull/95 with some sharp installation-related edges cleaned up.

Previously, setup.py would attempt the npm install as a custom install command, which broke things like setup.py develop and pip install -e .. Now, the npm install is run when readabilipy first tries to use node.

nelson-liu commented 1 year ago

Oops, I had meant to open this on my personal fork. if it's of interest, feel free to re-open and take a look, but otherwise I'm going to close this. Sorry for the noise.

jemrobinson commented 1 year ago

@nelson-liu, we don't currently have the available bandwidth to actively develop this project. If you're interested in joining the project, we could make you a developer.

nelson-liu commented 1 year ago

I'm not sure I'd also have the bandwidth to actively develop new features, but I'd be happy to look at incoming issues and PRs, if that's helpful? I do want to set up CI with GitHub actions, but I'm not sure what the permissions would look like there.

jemrobinson commented 1 year ago

Yes, that would probably be helpful too. If you want to add a GitHub Actions PR I can (hopefully) find some time to review it. As this is an open-source public repo, there shouldn't be a cost problem either.

nelson-liu commented 1 year ago

Sounds good to me.

nelson-liu commented 1 year ago

@jemrobinson , i ended up adding the GHA code to this PR because there are some installation-related fixes here too (e.g., moving off of the deprecated python setup.py install). Here's a diff with just the github actions-related commits, since it might be easier to review: https://github.com/alan-turing-institute/ReadabiliPy/compare/24e65084d5bb357013ffd9d8e9067ef80066c262..c3a1a83de008d477189d19760d3637548da6d4ed

It seems like the actions aren't running in this repo, perhaps you need to flip a bit in the repo settings? I was testing this PR out on my own fork, and the actions seem to run okay: https://github.com/nelson-liu/ReadabiliPy/pull/4

I'll add the lint / docs / other actions in a separate PR, don't want this one to get too massive.

jemrobinson commented 1 year ago

I've merged the PR this was based off and rebased. Can you remove the .travis.yml (which seems not to be running any longer) and possibly add a temporary additional target to test.yml that will allow the action to run on this PR.

nelson-liu commented 1 year ago

Looks like the actions still aren't running---are you sure that they're enabled on the repo? You might have to remove travis and coveralls from the "expected" / "required" checks in the repo settings.

jemrobinson commented 1 year ago

Ran actions locally with act and everything looks good.