[Feature Request] Algorithm Template

[arturomoncadatorres]

Problem description
It can be cumbersome to get the file structure right when developing a new algorithm

Desired solution
It would be great to have a template that could have all the initial files required, so that the developer can focus only on the actual development and the algorithm and doesn't need to spend so much on the things around it

Additional context
There is an existing boilerplate for vantage6. However, it is outdated and still requires some fiddling to get it right.

[bartvanb]

A few updates on this:

• We now intend to use copier instead of cookiecutter. The main reason to do so is the copier update functionality that allows you to update an algorithm when the template is updated.
• Work-in-progress repo is here: https://github.com/vantage6/v6-algorithm-template

TODO list

• clean up cookiecutter repo
• Create CLI command v6 algorithm create
  • note that the copier dependency has to be added to the CLI
• Create CLI command v6 algorithm update
• Ensure that there is a (CLI) command to submit an algorithm to the store from the template (later)
• Can we specify question 1 / N, 2 / N etc to give user an idea of how far they are?
• Add README to template creator repository and ensure it is not copied to algorithm template

List of questions we want to ask:

• Algorithm name
• Algorithm description
• Developer name
• Developer organization
• Licence
• Which function do you want
  • which arguments (+ type) does it need?
  • which decorators
• VPN stuff

Optional (advanced) questions:

• How to cite
• Link to git URL
• Link to documentation?
• output format?

[bartvanb]

Note that the CLI changes from #877 are necessary to implement the CLI part of this issue.

[frankcorneliusmartin]

Tested.

@bartvanb do we need to keep this issue open? As there are some open todos?

[bartvanb]

No, at present everything that is required for first version is implemented.
If/when we want to extend the list further, I think we should create a separate issue. Most points listed above could be things that we implement if we want to use the algorithm creator to automatically fill fields in the algorithm store.