Boavizta / boaviztapi

🛠 Giving access to BOAVIZTA reference data and methodologies trough a RESTful API
GNU Affero General Public License v3.0
73 stars 24 forks source link

requirement.txt file is outdated #324

Closed demeringo closed 3 weeks ago

demeringo commented 1 month ago

Bug description

Since we use poetry for dependency management, requirement.txt file is desynchronized with actual project dependencies.

I suspect it leads to false alerts by depndendabots.

To Reproduce

Expected behavior

Either get rid of requirement.txt or keep it up to date by making poetry update it.

JSON OUTPUT

Additional context

Not sure if there is any purpose to keep the requirement.txt file or if it remains there only by accident / historical reasons as it was used before we started to use Poetry.

It may still be used by the serverless deployment (which does not work at the moment #153 , so I am not sure if we should get complely rid of it or relocate it to a dedicated repository).

da-ekchajzer commented 1 month ago

The requirements.txt is used in clever-cloud for the public endpoint. Could we make a GitHub action that updates automatically the requirements.txt every time poetry dependency are updated ?

da-ekchajzer commented 1 month ago

Why is there a Pipfile it the repo ? Why do we need it ? Is the "pyproject.toml" enought ?

demeringo commented 1 month ago

Yes in theory the Poetry files ("pyproject.toml" and "poetry.lock") should be sufficient.

And I also believe that the pipfile is not needed once we use Poetry, but I would appreciate the view of @bamthomas or @samuelrince or other with experience in Python... I feel a bit rusty ;-)

For clever-cloud deployment: If needed for clever-cloud deployment we should be able to generate the requirement.txt file on the fly. My understanding is that this deployment is done manually today. We should document (and maybe automate the entire clever cloud deployment via an action). @AirLoren , do you have some info about how it is done ?

For the serverless deployment: According to the docs of serverless framework, there is no impact if we remove the requirement.txt (the frameworks plugin supports Poetry if no requirement is found).

samuelrince commented 1 month ago

Indeed, I don't think we need the Pipfile anymore. To generate a requirements.txt file, there is an official Poetry plugin.

bamthomas commented 1 month ago

Exacrly @demeringo it was just for the sake of migration and possible rollback but we should be done now :)

da-ekchajzer commented 3 weeks ago

Ok i will take charge of :

  1. Cleaning the repo (removing requirements.txt and pipfile
  2. Make a GitHub action that generates the requirements.txt when we push on the run-clever and dev-clever

Thanks for your feedbacks

da-ekchajzer commented 3 weeks ago

Everything is available on dev branch.