Pomaga zainstalować pakiet Pythona foo na komputerze (może być również w virtualenv), dzięki czemu można zaimportować pakiet foo z innych projektów, a także z monitów [i] Pythona.

wykonuje podobną pracę pip, easy_install itd.,

Za pomocą setup.py

Zacznijmy od kilku definicji:

Pakiet - folder / katalog zawierający plik __init__.py.
Module - poprawny plik Pythona z rozszerzeniem .py.
Dystrybucja - Jak jeden pakiet odnosi się do innych pakietów i modułów .

Powiedzmy, że chcesz zainstalować pakiet o nazwie foo. Więc robisz,

$ git clone https://github.com/user/foo  
$ cd foo
$ python setup.py install

Zamiast tego, jeśli nie chcesz go instalować, ale nadal chcesz go używać. Więc zrób,

$ python setup.py develop  

To polecenie utworzy dowiązania symboliczne do katalogu źródłowego w pakietach witryn zamiast kopiowania rzeczy. Z tego powodu jest to dość szybko (szczególnie w przypadku dużych paczek).

Tworzenie setup.py

Jeśli masz takie drzewo pakietów,

foo
├── foo
│   ├── data_struct.py
│   ├── __init__.py
│   └── internals.py
├── README
├── requirements.txt
└── setup.py

Następnie wykonaj następujące czynności w swoim setup.py skrypt tak, że można go zainstalować na jakiejś maszynie:

from setuptools import setup

setup(
   name='foo',
   version='1.0',
   description='A useful module',
   author='Man Foo',
   author_email='[email protected]',
   packages=['foo'],  #same as name
   install_requires=['bar', 'greek'], #external packages as dependencies
)

Zamiast tego, jeśli twoje drzewo pakietów jest bardziej złożone, jak to poniżej:

foo
├── foo
│   ├── data_struct.py
│   ├── __init__.py
│   └── internals.py
├── README
├── requirements.txt
├── scripts
│   ├── cool
│   └── skype
└── setup.py

Then, your setup.py w tym przypadku byłoby jak:

from setuptools import setup

setup(
   name='foo',
   version='1.0',
   description='A useful module',
   author='Man Foo',
   author_email='[email protected]',
   packages=['foo'],  #same as name
   install_requires=['bar', 'greek'], #external packages as dependencies
   scripts=[
            'scripts/cool',
            'scripts/skype',
           ]
)

Dodaj więcej rzeczy do (setup.py) & zrób to porządnie:

from setuptools import setup

with open("README", 'r') as f:
    long_description = f.read()

setup(
   name='foo',
   version='1.0',
   description='A useful module',
   license="MIT",
   long_description=long_description,
   author='Man Foo',
   author_email='[email protected]',
   url="http://www.foopackage.com/",
   packages=['foo'],  #same as name
   install_requires=['bar', 'greek'], #external packages as dependencies
   scripts=[
            'scripts/cool',
            'scripts/skype',
           ]
)

long_description jest używany w pypi.org jako opis README Twojej paczki.

I wreszcie, jesteś teraz gotowy, aby przesłać swój pakiet do PyPi.org aby inni mogli zainstalować Twój Pakiet używając pip install yourpackage.

Pierwszym krokiem jest odebranie nazwy pakietu i spacji w pypi za pomocą:

$ python setup.py register

Po zarejestrowaniu nazwy pakietu nikt nie może go odebrać ani używać. Po udanej rejestracji masz aby przesłać tam (do chmury) pakiet,

$ python setup.py upload

Opcjonalnie możesz również podpisać swoją paczkę za pomocą GPG przez,

$ python setup.py --sign upload

Bonus : Zobacz próbkę setup.py z prawdziwego projektu tutaj: torchvision-setup.py

setup.py jest odpowiedzią Pythona na wieloplatformowy instalator i plik make.

Jeśli znasz instalacje wiersza poleceń, to make && make install tłumaczy się na python setup.py build && python setup.py install.

Niektóre pakiety są czystym Pythonem i są kompilowane tylko bajtowo. Inne mogą zawierać kod natywny, który będzie wymagał kompilatora natywnego (jak gcc lub cl) i Modułu Interfejsu Pythona (jak swig lub pyrex).

Jeśli pobrałeś pakiet, który ma "setup.py" w folderze głównym możesz go zainstalować, uruchamiając

python setup.py install

Jeśli tworzysz projekt i zastanawiasz się do czego ten plik jest przydatny, sprawdź dokumentację Pythona przy pisaniu skryptu instalacyjnego

setup.py jest skryptem Pythona, który jest zwykle dostarczany z bibliotekami lub programami, napisanymi w tym języku. Jego celem jest prawidłowa instalacja oprogramowania.

Wiele pakietów używa frameworka distutils w połączeniu z setup.py.

Http://docs.python.org/distutils/

Setup.py może być używany w dwóch scenariuszach , po pierwsze, chcesz zainstalować pakiet Pythona. Po drugie, chcesz utworzyć własny pakiet Pythona. Zazwyczaj standardowy pakiet Pythona zawiera kilka ważnych plików, takich jak setup.py, setup.cfg i Manifest.in. podczas tworzenia pakietu Pythona, te trzy pliki określą (zawartość w PKG-INFO w folderze egg-info) nazwę, wersję, opis, inne wymagane instalacje (zwykle w .plik txt) oraz kilka innych parametrów. / align = "left" / cfg czyta się przez setup.py podczas tworzenia pakietu (może być tar.gz). Manifest.in to miejsce, w którym możesz określić, co powinno być zawarte w Twoim pakiecie. W każdym razie można zrobić kilka rzeczy za pomocą setup.py jak

python setup.py build
python setup.py install
python setup.py sdist <distname> upload [-r urltorepo]  (to upload package to pypi or local repo)

Istnieje kilka innych poleceń, które mogą być używane z setup.py . o pomoc

python setup.py --help-commands

Po pobraniu pakietu z setup.py Otwórz Terminal (Mac,Linux) lub wiersz polecenia (Windows). Za pomocą cd i przycisku Tab Ustaw ścieżkę do folderu, w którym pobrano plik i gdzie znajduje się setup.py:

iMac:~ user $ cd path/pakagefolderwithsetupfile/

Naciśnij enter, powinieneś zobaczyć coś takiego:

iMac:pakagefolderwithsetupfile user$

Następnie wpisz po tym python setup.py install:

iMac:pakagefolderwithsetupfile user$ python setup.py install

Naciśnij enter. Zrobione!

Aby zainstalować pobrany pakiet Pythona, rozpakuj archiwum i uruchom setup.py skrypt wewnątrz:

python setup.py install

Menedżer pakietów jest również wygodniejszy, ponieważ jest znany i niezawodny. Z drugiej strony, każda setup.py jest nowa, ponieważ jest specyficzna dla pakietu. Wymaga wiary w konwencję " ufam temu setup.py wykonuje te same polecenia, co inne, których używałem w przeszłości". To godny pożałowania podatek od siły woli.

Nie mówię, że setup.py workflow jest mniej bezpieczny niż menedżer pakietów (rozumiem, że Pip po prostu uruchamia setup.py wewnątrz), ale na pewno czuję, że jest to niezręczne i drażniące. Istnieje harmonia poleceń wszystkich będących w tej samej aplikacji menedżera pakietów. Może nawet go polubisz.

Aby to uprościć, setup.py jest uruchamiany jako "__main__" po wywołaniu funkcji install pozostałe wymienione odpowiedzi. Wewnątrz setup.py, należy umieścić wszystko, co potrzebne do zainstalowania pakietu.

Często setup.py funkcje

Następujące dwie sekcje omawiają dwie rzeczy, wiele setup.py moduły mają.

Setuptools.setup

Ta funkcja pozwala określić atrybuty projektu , takie jak nazwa projektu, wersja.... Najważniejsze, ta funkcja pozwala zainstalować inne funkcje, jeśli są prawidłowo zapakowane. Zobacz ta strona dla przykładu setuptools.konfiguracja

Te atrybuty setuptools.setup enable instalowanie tego typu pakietów:

• Pakiety, które są importowane do twojego projektu i wymienione w PyPI za pomocą setuptools.findpackages :

  Packages=find_packages (exclude=["docs","tests", ".gitignore", "README.rst", " opis.rst"])

• Pakiety nie w PyPI , ale można je pobrać z adresu URL używając dependency_links

  Dependency_links=["http://peak.telecommunity.com/snapshots/",]

Funkcje niestandardowe

setup.py jest plikiem Pythona jak każdy inny. Może przyjąć dowolną nazwę, z wyjątkiem konwencji, że nazywa się setup.py tak, że nie ma innej procedury z każdym skryptem.

Najczęściej setup.py jest używany do instalacji modułu Pythona, ale serwer do innych celów:

Moduły:

Być może jest to najbardziej znane użycie setup.py jest w modułach. Chociaż można je zainstalować za pomocą pip, stare wersje Pythona domyślnie nie zawierały pip i musiały być zainstalowany oddzielnie.

Jeśli chcesz zainstalować moduł, ale nie chcesz instalować pip, jedyną alternatywą było zainstalowanie modułu z pliku setup.py. Można to osiągnąć za pomocą python setup.py install. To zainstalowałoby moduł Pythona do głównego słownika (bez pip, easy_install ect).

Ta metoda jest często używana, gdy pip nie powiedzie się. Na przykład, jeśli poprawna wersja Pythona żądanego pakietu nie jest dostępna przez pip, być może dlatego, że nie jest już utrzymywane,, pobranie źródła i uruchomienie python setup.py install wykonałoby to samo, z wyjątkiem skompilowanych binariów, które są wymagane, (ale pominie wersję Pythona-chyba że zostanie zwrócony błąd).

Innym zastosowaniem setup.py jest instalacja pakietu ze źródła. Jeśli moduł jest nadal w fazie rozwoju, pliki wheel nie będą dostępne, a jedynym sposobem instalacji jest instalacja bezpośrednio ze źródła.

Python Budowlany rozszerzenia:

Po zbudowaniu modułu można go przekonwertować do modułu gotowego do dystrybucji za pomocą skryptu instalacyjnego distutils . Po zbudowaniu można je zainstalować za pomocą powyższego polecenia.

Skrypt instalacyjny jest łatwy do zbudowania i po prawidłowym skonfigurowaniu pliku można go skompilować uruchamiając python setup.py build (zobacz link dla wszystkich poleceń).

Po raz kolejny nazywa się setup.py dla łatwości użycia i konwencji, ale może przyjmować dowolne nazwisko.

Cython:

Inne słynne użycie plików setup.py zawiera skompilowane rozszerzenia. Wymagają one skryptu instalacyjnego z wartościami zdefiniowanymi przez użytkownika. Pozwalają one na szybkie (ale po skompilowaniu są zależne od platformy) wykonanie. Oto prosty przykład z dokumentacji :

from distutils.core import setup
from Cython.Build import cythonize

setup(
    name = 'Hello world app',
    ext_modules = cythonize("hello.pyx"),
)

Można to skompilować za pomocą python setup.py build

Cx_Freeze:

Kolejnym modułem wymagającym skryptu instalacyjnego jest cx_Freeze. Konwertuje skrypt Pythona na wykonywalne. Pozwala to na wiele poleceń, takich jak opisy, nazwy, ikony, pakiety do włączenia, wykluczenia ect i po uruchomieniu wytworzy dystrybuowalną aplikację. Przykład z dokumentacji :

import sys
from cx_Freeze import setup, Executable
build_exe_options = {"packages": ["os"], "excludes": ["tkinter"]} 

base = None
if sys.platform == "win32":
    base = "Win32GUI"

setup(  name = "guifoo",
        version = "0.1",
        description = "My GUI application!",
        options = {"build_exe": build_exe_options},
        executables = [Executable("guifoo.py", base=base)])

Można to skompilować za pomocą python setup.py build.

Co to jest plik setup.py?

Po prostu jest to skrypt, który buduje lub konfiguruje coś w środowisku Pythona.

Pakiet dystrybuowany powinien zawierać tylko jeden skrypt instalacyjny ale nie jest rzadkością łączenie kilku razem w jeden skrypt instalacyjny. Zauważ, że często dotyczy to distutils, ale nie zawsze (jak pokazałem w moim ostatnim przykładzie). Należy pamiętać, że po prostu konfiguruje Pakiet/skrypt Pythona w jakiś sposób.

Przyjmuje nazwę, więc zawsze można użyć tego samego polecenia podczas budowania lub instalowania.