Template "versions"

[egpbos]

As discussed in the first Python template team meeting, we are considering whether it makes sense to have multiple "versions" of the Python template.

The first thing that comes to mind is a minimalist version. This could even be completely Python-less, only focusing on generic research software best practices.

What other options would be useful?

[egpbos]

@NLeSC/python-template-nlesc-team

[vedran-kasalica]

I agree that a minimalist version should be available, but if we strip it of Python, the target audience would be non-Python users (is this template going to reach that audience?). Ignoring that concern, I think this version would be useful if it can be applied to an existing project. Otherwise, it makes the installation process more complex (with more options to choose from) and does not provide the necessary code structure, which would then have to be applied separately and might not integrate well (e.g., if you set up a Spring Boot project or a web app, you often generate the dummy code).

[c-martinez]

I agree with @vedran-kasalica, in that we need to think who is the target audience of this template. "Minimalist" does not necessarily have to mean "Pythonless". Maybe the minimalist python template is something with the target audience of users that have a few analysis scripts/notebooks.

[lyashevska]

@abelsiqueira took this approach with his BestieTemplate, and a few of us had an extensive brainstorming last week of what should be in a 'minimum' and/or 'full' template. In addition to that, I would think that also something like 'data' template could be useful (so without package).

[Cmurilochem]

Hi guys. I agree with @vedran-kasalica. In my opinion, the 'minimalist' version should include the minimum to start a python project according to the best practices advocated by NLeSC. I would say the this could be 5 things:

• an example module file
• test folder with one test example
• ci/cd workflow file that runs this test example
• simplest versions of README, CONTRIBUTING, and CITATION, LICENSE files
• setup.py

Do you agreed that these are 'minimum' ?

[c-martinez]

Hey @Cmurilochem !

It feels to me like your minimum is already a bit more strict than I would expect (maybe suited for a "medium" version of the template).

I think the 'minimum' version should be something that can be used for what the ARDC National Agenda for Research Software calls "Analysis code" (see page 4), and similar to what the Practical guide to Software Management Plans call "Management level: low" (see page 29).

I think we need to ask ourselves some questions like:

• How many versions of the template do we want to support?
• Who is the target audience of each version of the template?
• What best practices do they need?
• What best practices is that target audience willing to accept?
• Will our target audience use that template?

I hope this makes sense?