シラバス レッスン 250 中 240 · 総仕上げ:出荷する(プロジェクトをパッケージにする)
総仕上げ:出荷する(プロジェクトをパッケージにする)

リポジトリを配置する

これまでの総仕上げで本物のものを作りました:サポートのコパイロット、文書の抽出器、評価の関門。今はおそらく、セルの山か 1 本の長いスクリプトとして存在しているでしょう。それを開いた採用担当者は、どこに何があるかを推測しなければならず、クローンして実行する明らかな方法が見当たらなければ、リクルーターはタブを閉じてしまいます。ポートフォリオのプロジェクトのためにできる、いちばん効果の大きいことは、誰でも 30 秒で道がわかる退屈で慣習的な配置を与えることです。

最初に正直な注記:このモジュールはリポジトリについてのもので、ライブのクラウドへのデプロイについてではありません。ブラウザの中からサーバーを立ち上げたり、ホストに push したりはできませんし、できるふりもしません。ここで学んで証明できるのは、あとでデプロイを簡単にする構造、テスト、そして 1 つのコマンドでの実行です。最後のデプロイの注記は、まさにそれ -> 採点しないと印を付けた注記です。

ほとんどすべての Python のプロジェクトが行き着く配置:

my_project/
  README.md            # what it is + how to run it
  pyproject.toml       # name, version, dependencies
  .env.example         # the shape of the secrets (NEVER the real ones)
  src/
    my_project/        # the importable package
      __init__.py
      __main__.py      # runs on `python -m my_project`
      core.py          # your actual code
  tests/
    test_my_project.py # pytest finds these by the test_ prefix

注目すべき点が 2 つあります。1 つ目に、パッケージは src/ の下の、プロジェクトの名前を付けたフォルダーに住んでいます -> それが「src レイアウト」で、テストがインストールしたパッケージの代わりにうっかりローカルのフォルダーを import するのを防ぎます。2 つ目に、パッケージのディレクトリの名前はプロジェクトの名前に従います:triage というプロジェクトは src/triage/ を、copilot というプロジェクトは src/copilot/ を得ます。決まった 1 つの答えはありません -> 木は名前の関数なのです。

あなたの仕事は、その関数を書くことです。build_manifest(name) はプロジェクトの名前を受け取り、リポジトリが含むべきファイルのリストを、パスの文字列の並べ替えたリストとして返します。README.md、pyproject.toml、__init__.py とモジュールのファイルを持つ src/<name>/ の下のパッケージのディレクトリ、そして tests/test_*.py のファイルを含まなければなりません。名前を有効なパッケージのディレクトリに正規化してください(小文字にし、空白とハイフンをアンダースコアに変える。doc-extractor は import できるモジュール名ではありませんが、doc_extractor は import できるからです)。

これは、足場を作るスクリプトがディスクに作り出す目録です。採点プログラムの中でファイルを書くわけではありません -> どんなプロジェクトの名前についても正しい木を記述できるかを確かめているのです。実行を押して、triage というプロジェクトの配置を出力しましょう。

あなたの番

プロジェクトのリポジトリのファイルの木を、パスの文字列の並べ替えたリストとして返す build_manifest(name) を書いてください。README.md、pyproject.toml、__init__.py と __main__.py(そのファイルが、レッスン 3 の実行コマンドである python -m <pkg> を動くようにします)と少なくとも 1 つのほかのモジュールの .py ファイルを持つ src/<pkg>/ の下のパッケージのディレクトリ、そして tests/test_<pkg>.py という名前のテストのファイルを含まなければなりません。違うプロジェクトの名前から違う木ができるように、name をパッケージのディレクトリに正規化します(小文字にし、空白とハイフンはアンダースコアになる)。

このレッスンに問題を見つけましたか?報告する · このレッスンについて質問する

この演習はまもなく開きます

その前のレッスンを終えると、このレッスンが解放されます。コース全体が無料でアカウントも不要、このレッスンは今すぐ読めます。