Devo includere script in un pacchetto Python?

Due anni dopo, sento di poter rispondere alla mia domanda.

È preferibile utilizzare il metodo Setuptools entry_points . Questo è descritto bene nella documentazione dei clic , e i punti principali sono:

• funziona meglio su Windows
• Pythonpath è gestito da Setuptools, quindi (ad esempio) se lo script è installato all'interno di una virtualenv, non è necessario attivare virtualenv perché funzioni correttamente

Sì, questo è possibile e abbastanza comune per i pacchetti che fungono sia da strumenti da riga di comando sia da librerie importate.

In setup.py , aggiungi la funzione di un modulo come punto di ingresso:

setuptools.setup(
    ...
    entry_points={'console_scripts': [
        'foo = my_package.some_module:main_func',
    ]},
    ...
)

Per creare uno script denominato foo che chiama la funzione my_func all'interno di my_package.some_module . Maggiori informazioni su link .

È anche una convenzione da aggiungere:

#!/usr/bin/env python

...

if __name__ == '__main__':
    my_func()

ai moduli che possono essere chiamati "script" dove my_func è la funzione che desideri chiamare esternamente.

Ecco un esempio di setup.py :

link

e un modulo richiamabile:

link

Se si intende far utilizzare il codice della libreria da altri pacchetti, è necessario separarlo dagli script. Ciò è dovuto al modo in cui le dipendenze sono dichiarate in setup.py e requirements.txt (vedi qui ) .

Se il codice della libreria verrà utilizzato solo con questi script, è possibile scegliere. Vorrei scegliere di tenerli insieme per mantenere le cose un po 'più semplici