README + Tek Komutla Çalıştır
Temiz bir düzenin ve gerçek testlerin var. Son kilometre, inceleyenlerin aslında ilk karşılaştığı kısım: README ve şeyi çalıştıran tek komut. Başlatması on dakika tahmin gerektiren bir proje çalışsa bile bozuk hissettirir. Klonlayıp tek bir satırla çalıştırabildiğin bir proje küçük olsa bile profesyonel hissettirir. Aynı kod -> çok farklı izlenim.
README bir sözleşmedir. Bir okuyucu onu yukarıdan aşağı göz gezdirir, ve tahmin edilebilir bir biçim bekler: başlık olarak projenin adı, sonra nasıl kurulacağı, sonra nasıl kullanılacağı, sonra nasıl test edileceği. Somut olarak, güçlü bir README'nin üst düzey bir başlık satırı (# Something), sonra bu sırayla şu bölümleri vardır:
# Triage Copilot
## Setup
pip install -e . # editable install
cp .env.example .env # then paste your real key into .env
## Usage
python -m triage # the one-command run
## Tests
pytest
Sıra önemlidir çünkü bir okuyucu onu adımlar olarak izler. Kurulumdan önce Kullanım kafa karıştırır -> kurmadığın şeyi kullanamazsın. Bu yüzden bir kontrolcü yazıyorsun, validate_readme(text): yalnızca bir # başlığı görünüyorsa, ardından ## Setup, sonra ## Usage, sonra ## Tests, her biri bir öncekinden sonra geliyorsa True döndürür. Eksik bir bölüm, ya da sırası bozuk bölümler False döndürür. Püf noktası: satırları bir kez gez, nerede olduğunun bir "imlecini" tut, ve her bölümün imleçten sonraki bir konumda görünmesini şart koş.
Tek komutlu çalıştırma. Yukarıdaki ## Usage satırının tek bir komut olduğuna dikkat et. Bir Makefile ya da justfile hedefinin, make run gibi, amacı budur -> projeyi başlatan akılda kalıcı tek bir komut, böylece kimse tam çağrıyı hatırlamak zorunda kalmaz. Bir proje için o komut dizgisini döndüren make_run(name) yaz, örneğin python -m triage (ya da make run). Proje adını, paket dizini ile aynı şekilde normalleştirilmiş olarak içermeli, böylece farklı bir proje farklı bir komut verir.
Gerçek depo için iki dürüst, notlanmayan not. Birincisi, sırlar: cp .env.example .env adımı, gerçek API anahtarın .env'e girdiği için vardır; onu .gitignore'a eklersin ve asla commit etmezsin. Yalnızca .env.example'ı commit edersin -> yer tutucu değerlerle yapılandırmanın biçimi. Bir anahtarı genel bir depoya sızdırmak klasik portföy projesi hatasıdır. İkincisi, bunu yayına almak: onu çevrimiçi koymak için küçük bir Dockerfile yazar (depoyu kopyala, pip install, çalıştırma komutunu giriş noktası olarak ayarla) ve Render, Railway ya da Fly gibi bir PaaS'a gönderirdin. O kısım tarayıcında çalıştırılamaz ya da notlanamaz -> yayınladığında senin yapacağın iştir. Tam bir README'yi doğrulamak ve çalıştırma komutunu yazdırmak için Çalıştır'a bas.
İyi bir README'in iki deterministik parçasını yaz. validate_readme(text), bir üst seviye # başlığı, sonra ## Setup, sonra ## Usage, sonra ## Tests göründüğü sürece her biri bir öncekinden sonra gelirse True döndürür (eksik bir bölüm veya sırasız bölümler -> False). make_run(name), proje adını paket dizini gibi normalize edilmiş şekilde içine alan tek komutluk çalıştırma dizgisini (örneğin python -m <pkg> veya make run) döndürür, böylece farklı bir isim farklı bir komut üretir.
Bu derste bir sorun mu fark ettin? Bildir · Bu ders hakkında soru sor
Bu alıştırma yakında açılacak
Bu dersi bitirince bu ders açılacak. Kursun tamamı ücretsiz, hesap gerekmiyor ve bu dersi hemen şimdi okuyabilirsin.
Bu tarayıcı learn.floati.life için çerezleri engelliyor, bu yüzden burada bitirdiğin dersler sırasıyla açılamıyor. Bu site için çerezlere izin ver ve sayfayı yenile.