1. 必要なライブラリのインストール#

Biocondaでの作業に必要なCLI（git、gh、grayskull）をconda-forge経由でインストールします。

1
conda install -c conda-forge git gh grayskull

ghはGitHub CLIツールです。以下のコマンドでログインします。

1
gh auth login

2. bioconda-recipesのforkとclone#

以下のコマンドでbioconda-recipesをforkし、必要に応じてcloneまたは同期します。

1
# もし既にforkしている場合は、最新状態に同期します
2
gh repo sync akikuno/bioconda-recipes -b master ||
3
    gh repo fork bioconda/bioconda-recipes
4

5
# もしcloneしていない場合はcloneします
6
if ! [ -f bioconda-recipes/README.md ] ; then
7
    git clone https://github.com/akikuno/bioconda-recipes.git
8

9
# もしclone済みの場合は、最新状態に同期します
10
else
11
    (cd bioconda-recipes && git remote add upstream https://github.com/bioconda/bioconda-recipes.git)
12
    (cd bioconda-recipes && git switch master && git fetch upstream && git merge upstream/master)
13
fi

NOTE

コマンド名のakikunoは自分のGitHubユーザー名に置き換えてください。

3. grayskullでmeta.yamlを生成#

grayskullはcondaパッケージのmeta.yamlを自動生成するツールです。

1
mkdir -p metayaml
2
(cd metayaml && grayskull pypi TSUMUGI)

これにより、metayaml/TSUMUGI/meta.yamlが生成されます。

4. meta.yamlの修正#

生成されたmeta.yamlに、Biocondaへの登録に必要な以下の項目を加筆します。

• buildセクションにrun_exportsを追加します。
• aboutセクションにhome、dev_url, doc_urlを追加します。

IMPORTANT

run_exportsとhomeは記載がないとリントが通らないため必須です。
dev_url, doc_urlは別のパッケージのレビューで指摘されたため、追記を推奨します。

NOTE

run_exportsは、Biocondaパッケージを他のパッケージが利用するときに許容されるバージョン範囲を示します。
指定すると依存パッケージ側で安全なバージョン範囲が自動的に設定され、互換性の問題を防げます。
例えば{{ pin_subpackage('tsumugi', max_pin="x.x") }}なら、0.5.0→0.5.1のようなマイナーバージョン更新は許容されますが、0.5.0→0.6.0のようなメジャーバージョン更新は許容されません。
安定版(1.0.0)前はマイナーバージョンで破壊的変更が入る可能性が高いため、max_pin="x.x"を推奨します。

最終的なmeta.yamlは、以下のとおりです：

1
{% set name = "TSUMUGI" %}
2
{% set version = "0.5.0" %}
3

4
package:
5
  name: {{ name|lower }}
6
  version: {{ version }}
7

8
source:
9
  url: https://pypi.org/packages/source/{{ name[0] }}/{{ name }}/tsumugi-{{ version }}.tar.gz
10
  sha256: b3b3a8e0acb8a0f4326e45aabb10d7d3b9e0f0cd432ef0cc49f3d61aeae04350
11

12
build:
13
  entry_points:
14
    - tsumugi = TSUMUGI.main:main
15
  noarch: python
16
  script: {{ PYTHON }} -m pip install . -vv --no-deps --no-build-isolation
17
  number: 0
18
  run_exports:
19
    - {{ pin_subpackage('tsumugi', max_pin="x.x") }}
20

21
requirements:
22
  host:
23
    - python >=3.10
24
    - poetry-core
25
    - pip
26
  run:
27
    - python >=3.10
28
    - numpy >=1.21.0
29
    - tqdm >=4.64.0
30
    - networkx >=3.3
31

32
test:
33
  imports:
34
    - TSUMUGI
35
  commands:
36
    - pip check
37
    - tsumugi --help
38
  requires:
39
    - pip
40

41
about:
42
  summary: 'TSUMUGI: Phenotype-driven gene network identifier'
43
  license: MIT
44
  license_file: LICENSE
45
  home: "https://github.com/akikuno/tsumugi"
46
  dev_url: "https://github.com/akikuno/tsumugi"
47
  doc_url: "https://github.com/akikuno/tsumugi/blob/{{ version }}/README.md"
48

49

50
extra:
51
  recipe-maintainers:
52
    - akikuno

5. meta.yamlの配置#

生成したmeta.yamlを、bioconda-recipesのrecipes/tsumugi/meta.yamlとして配置します。

1
mkdir -p bioconda-recipes/recipes/tsumugi
2
cp metayaml/TSUMUGI/meta.yaml bioconda-recipes/recipes/tsumugi/meta.yaml

6. Pull Requestの作成#

作成したmeta.yamlをコミットします。

仮にブランチ名をadd-tsumugi-0.5.0とした場合、以下のコマンドを実行します。

1
(
2
  cd bioconda-recipes
3
  git checkout -b add-tsumugi-0.5.0
4
  git add recipes/tsumugi/meta.yaml
5
  git commit -m "Add TSUMUGI version 0.5.0"
6
  git push origin add-tsumugi-0.5.0
7
)

以下のURLにアクセスし、Pull Requestを作成します。

https://github.com/<ユーザー名>/bioconda-recipes/pull/new/<ブランチ名>

これでbioconda-recipesリポジトリに対してPull Requestが作成されます。

7. 自動テストとメンション#

Pull Requestを作成すると、自動テストが走ります。 自動テストが通過したら、コメント欄に

@BiocondaBot please add label

とメンションします。

IMPORTANT

@BiocondaBot please add labelを忘れると永遠にレビューしてくれません（数敗）。
必ずコメントしてください。

8. マージと公開#

有志の方が最終チェックし、問題がなければマージされます。

IMPORTANT

この最終チェックはボランティアの方が行っているため、チェックまでに数日がかかる場合があります。
感謝の気持ちでお待ちください🙏

マージされると、数分でBiocondaにパッケージが公開されます。

NOTE

以降のバージョン更新はPyPIの更新に自動で追従します。