A data science cookiecutter

Aperta
#415 9 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python
Ambito
tooling

Direzione di ricerca

Start by reviewing the proposed data-science cookiecutter goals and comparing the two linked research cookiecutter examples. The issue names no files, tests, or implementation entry point; the work is done when the project scope and whether to implement or recommend an existing template are decided and documented.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement
Is Your Feature Request Related to a Problem? Please Describe

We recently chatted with @samcunliffe and Niko from SWC (cannot tag him) about a cookiecutter for data science / scientific analysis / exploratory Python projects.

The idea would be to have some lighter requirements than for a fully-fledged Python package. And maybe some data science specific additions (like for example functionality for formatting and checking notebooks). This could be useful for many researchers, and maybe a good entry point to getting into good software practices.

Describe the Solution You'd Like

If we find this could be useful, we could have it:

  • in a separate repo, or
  • as part of this repo, and ask the user in the initial config phase which version they want to instantiate. @samcunliffe mentioned we could maybe use hidden variables for this.

Alternatively, we can just point to a good cookiecutter for this purpose if that already exists.

Describe Alternatives You've Considered

There are some examples of research cookiecutter:

  • this one is very basic (mostly a directory structure) but maybe a good starting point if we decide we want to implement this ourselves.
  • this one seems more recent and quite well documented. It may be a good one to point to if we decide that doing one ourselves is out of scope
Additional Context

No response

Lingua principale
Python
Stelle
62
Fork
10
Merge medio
7g 6h
PR unite (30g)
6

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di UCL-ARC/python-tooling

Tutte le issue di UCL-ARC/python-tooling

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.