cleanup to prepare for the 0.1 release

Yale-LILY / SummerTime

An open-source text summarization toolkit for non-experts. EMNLP'2021 Demo

https://arxiv.org/abs/2108.12738

Apache License 2.0

264 stars 30 forks source link

cleanup to prepare for the 0.1 release #67

Closed niansong1996 closed 3 years ago

niansong1996 commented 3 years ago

Cleaned up files/dirs that are not touch for 5+ months.

There are some files that I am not sure whether they can be deleted, for which I will ask people to take a look in the follow-up thread.

niansong1996 commented 3 years ago

A list of files I am not sure about:

@chatc is .gitmodules still needed?
@MuroriM is SummerTime.egg-info automatically generated? if so, can we delete this?
@troyfeng116 why do we need summertime.py for building? it seems a bit awkward lying in the top-level folder like that, if it's necessary, can we move it to test or smth? And the same thing for download.py
@troyfeng116 @MuroriM can we delete summertime_pkg?
@troyfeng116 why we have requirements.txt and dependencies.txt at the same time?

MuroriM commented 3 years ago

@niansong1996 Most of the files mentioned above SummerTime.egg-info, summertime.py, summertime_pkg are from the previous pip package creation. We should definitely remove them as they are unnecessary right now and might lead to confusion down the line.

But I'd first double-check with @troyfeng116 , on which files are needed for Travis as it might be using some of the files.

To view files from the previous pip efforts, I recommend taking a look at this branch murori/pip-package

troyfeng116 commented 3 years ago

@niansong1996 The tests don't use summertime.py, I do think download.py is needed though. summertime_pkg can be deleted. And I think dependencies.txt has been there for a while now, I don't know why it's there so we can remove it

niansong1996 commented 3 years ago

@troyfeng116 I had a failed build with commit 7d781fb because of trying to find summertime.py that I deleted, then I added it back in f8f3040 and the build passes, do you know why this is?

troyfeng116 commented 3 years ago

@troyfeng116 I had a failed build with commit 7d781fb because of trying to find summertime.py that I deleted, then I added it back in f8f3040 and the build passes, do you know why this is?

Looks like it's used in setup.py, I guess we can either remove that script or leave it there

niansong1996 commented 3 years ago

I do think download.py is needed though.

@troyfeng116 What's the functionality of it? May we move it inside one of the folders?

MuroriM commented 3 years ago

I created setup.py for the pip package. If it doesn't serve any other purpose, we can delete both setup.py and summertime.py

niansong1996 commented 3 years ago

@MuroriM setup.py should still be there, but summertime.py is included in it as a startup script, which is unnecessary, so I've deleted it in 0fa09ac

troyfeng116 commented 3 years ago

@troyfeng116 What's the functionality of it? May we move it inside one of the folders?

Actually looks like it's not needed, we can delete it

niansong1996 commented 3 years ago

Thanks, @troyfeng116 Btw, do you know why do we need an __init__.py at the top level?

troyfeng116 commented 3 years ago

Thanks, @troyfeng116 Btw, do you know why do we need an __init__.py at the top level?

No that was there way before, maybe to make importing easier for local repos? Not necessary for tests or anything else dev-wise

niansong1996 commented 3 years ago

No that was there way before, maybe to make importing easier for local repos? Not necessary for tests or anything else dev-wise

I see, let me try to remove it and if all tests are still passing, probably means that it's useless