Silabus Pelajaran 240 dari 250 · Proyek Akhir: Ship It (Kemas Proyekmu)
Proyek Akhir: Ship It (Kemas Proyekmu)

Atur Repo

Kamu sudah membangun sesuatu yang nyata di capstone sebelumnya: copilot pendukung, ekstraktor dokumen, dan eval gate. Sekarang mungkin hasilnya hanya tumpukan sel atau satu skrip panjang. Manajer perekrutan yang membukanya harus menebak di mana letak bagian-bagiannya, dan perekrut yang mengkloningnya lalu tidak melihat cara jelas untuk menjalankannya akan langsung menutup tab. Hal dengan pengaruh tertinggi yang bisa kamu lakukan untuk proyek portofolio adalah memberinya tata letak yang membosankan dan konvensional supaya siapa pun bisa mencari jalan di dalamnya dalam 30 detik.

Catatan jujur di awal: modul ini tentang repo, bukan deploy cloud langsung. Kita tidak bisa menjalankan server atau push ke host dari dalam browser kamu, dan kita tidak akan berpura-pura bisa. Apa yang can kamu pelajari dan buktikan di sini adalah struktur, tes, dan satu perintah jalan yang membuat deploy jadi mudah nanti. Catatan deploy di akhir adalah catatan itu saja -> catatan, ditandai tidak dinilai.

Tata letak yang hampir setiap proyek Python gunakan:

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

Ada dua hal yang perlu diperhatikan. Pertama, package berada di bawah src/ dalam folder yang dinamai sesuai proyek -> itu adalah "src layout", dan ini mencegah tes kamu mengimpor folder lokal secara tidak sengaja alih-alih package yang terinstal. Kedua, nama direktori package mengikuti nama proyek: proyek bernama triage mendapatkan src/triage/, proyek bernama copilot mendapatkan src/copilot/. Tidak ada satu jawaban tetap -> pohon tersebut adalah fungsi dari nama.

Tugas kamu adalah menulis fungsi itu. build_manifest(name) mengambil nama proyek dan mengembalikan daftar file yang harus ada di repo, sebagai sorted daftar string path. Harus menyertakan README.md, pyproject.toml, direktori paket di bawah src/<name>/ yang berisi __init__.py dan file modul, serta file tests/test_*.py. Normalisasi namanya menjadi direktori paket yang valid (huruf kecil, dan ubah spasi serta tanda hubung menjadi garis bawah, karena doc-extractor bukan nama modul yang bisa diimpor tapi doc_extractor bisa).

Ini adalah manifest yang akan dibuat oleh skrip scaffolding di disk. Kita tidak menulis file di grader -> kita memeriksa apakah kamu bisa mendeskripsikan struktur pohon yang benar untuk nama proyek apa pun. Tekan Run untuk mencetak tata letak untuk proyek bernama triage.

Giliranku

Tulis build_manifest(name) yang mengembalikan struktur pohon file repo untuk sebuah proyek sebagai daftar string path yang terurut sorted. Harus menyertakan README.md, pyproject.toml, direktori paket di bawah src/<pkg>/ dengan __init__.py, sebuah __main__.py (file itu yang membuat python -m <pkg>, perintah jalan di pelajaran 3, berfungsi) dan setidaknya satu file modul .py lainnya, dan sebuah file tes bernama tests/test_<pkg>.py. Normalisasi name ke dalam direktori paket (huruf kecil, spasi dan tanda hubung menjadi garis bawah) sehingga nama proyek yang berbeda menghasilkan pohon yang berbeda.

Ada masalah di pelajaran ini? Laporkan · Tanya tentang pelajaran ini

Latihan ini akan segera dibuka

Selesaikan pelajaran sebelumnya agar pelajaran ini terbuka. Seluruh kursus ini gratis, tidak butuh akun, dan kamu bisa baca pelajaran ini sekarang.