Come posso fare in modo che questa descrizione lunga e README differiscano di un paio di frasi?

Question

Per un pacchetto di mio, Ho un file README.rst che viene letto nella lunga descrizione del setup.py in questo modo:

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

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

questo modo che io possa avere il file README mostrano sul mio github page ogni tempo che commetto e su pypi page ogni volta che I python setup.py register. C'è solo un problema. Mi piacerebbe che la pagina di github dicesse qualcosa come "Questo documento riflette una versione preliminare di envbuilder .Per la versione più recente, guarda pypi."

Potrei semplicemente mettere quelle righe in README.rst e cancellarle prima di I python setup.py register, ma so che ci sarà un tempo in cui dimenticherò di rimuovere le frasi prima di premere su pypi.

Sto cercando di pensare al modo migliore per automatizzare questo, quindi non devo preoccuparmi di questo. Qualcuno ha qualche idea? C'è qualche magia di setuptools/distutils che posso fare?

Answer 1

È possibile utilizzare un commento di ripetizione con un testo come "dividi qui" e quindi suddividerlo in setup.py. Ian Bicking lo fa in virtualenv con index.txt e setup.py.

Answer 2

Si può sempre fare questo:

GITHUB_ALERT = 'This document reflects a pre-release version...' 
readme = open('README.rst', 'r') 
README_TEXT = readme.read().replace(GITHUB_ALERT, '') 
readme.close() 

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

Ma allora si sarebbe dovuto tenere quella stringa GITHUB_ALERT in sincronia con la formulazione stessa del README. Utilizzare invece un'espressione regolare (per dire, abbinare una riga che inizia con Nota per utenti Github: o qualcosa) potrebbe darti un po 'più di flessibilità.

Answer 3

Un'altra opzione è quella di risolvere completamente il problema aggiungendo un paragrafo che funziona in entrambi gli ambienti: "L'ultimo codice instabile è su github. Gli ultimi kit stabili sono su pypi."

Dopo tutto, perché presumere che le persone pypi non vogliono essere puntate su github? Ciò sarebbe più utile per entrambi i segmenti di pubblico e semplifica il tuo setup.py.