6 python structure

[rogerkuou]

Partially work on #6

• github workflows
• readme and badges
• pyproject.toml
• docs
• src
• setup main branch protection
• citation.cff
• pre-commit hook: as dev dependency and config file
• rename the repo
• add a logo (optional)
• pypi and zenodo account (check who from project partners can be the admin)

[rogerkuou]

Hi @SarahAlidoost and @meiertgrootes, I added the Python structure as much as we can. Can you give it a look?

I plan to leave the unfished tasked uncheck in #6, and fix them in another PR.

For the name of this workflow, maybe you can give some suggestions? I will do the logo together with it.
For PyPI and zenodo account, is the idea that we should ask someone else to own it?

[SarahAlidoost]

please also add Bouwe to the list.

[SarahAlidoost]

Hi @SarahAlidoost and @meiertgrootes, I added the Python structure as much as we can. Can you give it a look?

Thanks! 👍

For the name of this workflow, maybe you can give some suggestions? I will do the logo together with it.

For PyPI and zenodo account, is the idea that we should ask someone else to own it?

@bouweandela can you help with this, how is this done in esmvalgroup?

[SarahAlidoost]

@rogerkuou looks good! thanks 👍 just a few comments, then feel free to merge it.

[meiertgrootes]

Looks good. I have nothing to add to @SarahAlidoost 's comments.

[rogerkuou]

Thanks @SarahAlidoost and @meiertgrootes. I adapted all of Sarah's comments. And added one more thing: the precommit hook config file, where I called ruff for linting and formatting. Will merge this now. The issue still remains open until we finish the rest items.

[bouweandela]

For PyPI and zenodo account, is the idea that we should ask someone else to own it?

@bouweandela can you help with this, how is this done in esmvalgroup?

For PyPI, we have an ESMValGroup organization and use trusted publishing. If you feel it would be useful to publish the package to PyPI, I can create the project (once you have decided on a name) and set up trusted publishing for you.

For Zenodo: for the other repositories we have a few owners, but maybe we could create an ESMValGroup community. Do you have experience with these? Would that allow editing metadata of the records?