Bu long_description ve README'yi birkaç cümle ile nasıl ayırt edebilirim?

Question

Benim bir paket için, setup.py'nin uzun açıklamasında okunan bir README.rst dosyası var:

readme = open('README.rst', 'r') 
README_TEXT = readme.read() 
readme.close() 

setup(
    ... 
    long_description = README_TEXT, 
    .... 
    ) 

README dosyasına sahip olduğum şekilde github page üzerinde Ben python setup.py register her zaman pypi page üzerinde işlemek ve zaman. Sadece bir problem var. Github sayfasının "Bu belge envbuilder'ın yayın öncesi sürümünü yansıtır. En son yayınlanan sürüm için bkz. Pipi" gibi bir şey söylemesini isterim.

Bu satırları README.rst dosyasına koyup python setup.py register'ten önce silebilirim, ama pypi'ye basmadan önce cümleleri çıkarmayı unuttuğum bir zaman olacağını biliyorum.

Bunu otomatikleştirmek için en iyi yolu düşünmeye çalışıyorum, bu yüzden endişelenmenize gerek yok. Herhangi bir fikri olan var mı? Yapabileceğim herhangi bir kurulum/distutils büyüsü var mı?

Answer 1

ReST yorumunu "burada böl" gibi bir metinle birlikte kullanabilir ve daha sonra da setup.py'nizde buna bölebilirsiniz. Ian Bicking, index.txt ve setup.py ile virtualenv içinde yapar.

Answer 2

Hep bunu yapabilir. Bunun yerine düzenli bir ifade kullanarak (örneğin, ile başlayan bir çizgiyi eşleştirin. Github Kullanıcıları için Not: veya bir şey) size biraz daha esneklik sağlayabilir.

Answer 3

Başka bir seçenek de, her iki ortamda da çalışan bir paragraf ekleyerek konunun tamamen yan tarafına atılmasıdır: "En son kararsız kod, github üzerindedir. En son kararlı kitler pypi üzerindedir." Sonuçta, neden pypi insanlarının github'a işaret edilmek istemediğini varsayalım? Bu, hem kitleler için daha yararlı olur ve setup.py'nizi basitleştirir.