A data science cookiecutter

オープン
#415 コメント 9 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
python
領域
tooling

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
Python
スター
62
フォーク
10
平均マージ
7日 6時間
マージ済み PR(30日)
6

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

UCL-ARC/python-tooling のほかの issue

UCL-ARC/python-tooling の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。