Add heroku deployment scripts

[ltalirz]

This PR adds a deployment of the optimade server to heroku - integrated with CI, this allows us to always have a working optimade server of the current development branch (or master, whatever we like) to play around with.
This could be used to e.g. have an "interactive" documentation with this server + swagger (see also Materials-Consortia/materials-consortia.github.io#5 ).

optimade.herokuapp.com is currently linked to my fork of optimade-python-tools but I'll relink it to the main repository once this is reviewed & merged.

Test: https://optimade.herokuapp.com/optimade/structures

[ml-evs]

This is a great idea and will surely be useful, cheers @ltalirz!

I see it introduces the requirements file again, is this just for heroku to use? Could it be put in e.g. .heroku or somewhere off the top-level to avoid confusion, or are we moving back to using it for all oru deps?

[ltalirz]

I see it introduces the requirements file again, is this just for heroku to use?

Yes

Could it be put in e.g. .heroku or somewhere off the top-level to avoid confusion

Not sure, I could try but it needs to be detected by heroku.
One alternative would be to make the "server" extra_requirements part of the default requirements - in that case we can remove the requirements.txt .

For me that would seem fine, since people installing the app will typically want to run the server.
Anyhow, let me know what you guys think @ml-evs @CasperWA

[CasperWA]

One alternative would be to make the "server" extra_requirements part of the default requirements - in that case we can remove the requirements.txt .

For me that would seem fine, since people installing the app will typically want to run the server.

I don't agree. As an example, we (Materials Cloud) do not want to run the server. Although, with the addition of the index meta-database server, we do want to run that.

Maybe with the addition of the index meta-database, which can be properly configured using the server.cfg file, one can justify adding "server" to the core requirements of this package? Although, I still sort of prefer it not to be.

[CasperWA]

This is a great little tool, thanks @ltalirz!

However, along with @ml-evs I am a bit concerned about the re-addition of the requirements.txt - we essentially already have it under .github/ for GH Actions.
Furthermore, along the lines of @ml-evs's comment, with the re-structuring of the package, it would be nice to put specific heroku files under a dedicated directory if possible.

[CasperWA]

If this gets merged before #68, could you please make sure this gets added to that PR?

[ltalirz]

ok, I've worked around the requirements.txt issue by fixing the Pipfile instead.
Ready for re-review.

[ml-evs]

Thanks for the changes @ltalirz!

Happy to accept this once we we've merged the readme PR. Quick question in the meantime: how is the heroku auth set up? Is it your personal account or can anyone modify the config? I see they have a github action actions/heroku which might circumvent this (if it's not too much extra effort)?

(I've never used heroku so apologies if these questions are irrelevant)

[ltalirz]

Is it your personal account or can anyone modify the config?

Heroku has the concept of "apps" and access can be configured for each app individually.
Happy to add anyone from the optimade github org as maintainers of the app (just let me know the email of your heroku account).

I see they have a github action actions/heroku which might circumvent this (if it's not too much extra effort)?

I don't think this would significantly change things, since in the end you still need to set up the app.

[ml-evs]

I don't think this would significantly change things, since in the end you still need to set up the app.

Okay, cheers! If you can fix the README conflicts then I'll accept.

[ltalirz]

Fixed the conflict.
The table now needs two rows for the badges
https://github.com/Materials-Consortia/optimade-python-tools/blob/2283186c631216032ecb6c9d2b7e2334a1b948eb/README.md

I could leave it like this or perhaps remove the "commit activity" one to go back to one line.

[ml-evs]

I could leave it like this or perhaps remove the "commit activity" one to go back to one line.

Up to you, I'll accept either way.

[ltalirz]

I've now pointed the app to the official optimade-python-tools repo.
Happy to add anyone as a maintainer.