Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Template "versions"#395

egpbos started this conversation inIdeas
Jul 5, 2024· 6 comments
Discussion options

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?

You must be logged in to vote

Replies: 6 comments

Comment options

egpbos
Jul 5, 2024
Maintainer Author

@NLeSC/python-template-nlesc-team

You must be logged in to vote
0 replies
Comment options

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).

You must be logged in to vote
0 replies
Comment options

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.

You must be logged in to vote
0 replies
Comment options

@abelsiqueira took this approach with hisBestieTemplate, 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).

You must be logged in to vote
0 replies
Comment options

Hi guys. I agree with@vedran-kasalica. In my opinion, the 'minimalist' version should include the minimum to start a python projectaccording 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' ?

You must be logged in to vote
0 replies
Comment options

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 theARDC National Agenda for Research Software calls "Analysis code" (see page 4), and similar to what thePractical 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?

You must be logged in to vote
0 replies
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Category
Ideas
Labels
None yet
5 participants
@egpbos@c-martinez@vedran-kasalica@lyashevska@Cmurilochem

[8]ページ先頭

©2009-2025 Movatter.jp