Jak w Pythonie przekazać użyte biblioteki czyli requirements.txt
Użycie Pythona w projektach
W projektach związanymi z danymi, coraz częściej możesz spotkać Pythona. Nie chodzi nawet o zaawansowane rozwiązania Data Engineeringowe. Być może stworzyłeś skrypty do automatyzacji zadań. Ja od takich zaczynałem moją przygodę z Pythonem.
W końcu nadchodzi ten moment, w którym chciałbyś przekazać swoje rozwiązanie innej osobie, podzielić się nim z Zespołem. Bez ciągłych błędów związanych z brakiem zainstalowanych bibliotek.
Pokażę Ci szybki sposób jak stworzyć plik requirements.txt, dzięki któremu będziesz miał listę wszystkich bibliotek wraz z ich wersjami.
Dzięki temu będziesz mógł w prosty sposób przekazać innym współpracownikom listę bibliotek do działania, dzięki czemu będą mogli zainstalować wszystkie biblioteki na swoim środowisku.
Konfiguracja środowiska wirtualnego
Zalecam pracę w środowisku wirtualnym. Zakładam, że masz już zainstalowanego Pythona. Jeśli jednak nie, a temat ten Was zainteresuje i chcielibyście go zgłębić, dajcie znać. Nie wchodząc w głębsze szczegóły, chodzi o „odizolowanie projektu”, nad którym pracujecie. Tak, aby nie było problemów związanych z zależnościami między bibliotekami itp.
Może zdarzyć się przecież, że dany projekt jest zbudowany w jednej konkretnej wersji biblioteki, w międzyczasie wyszła nowsza, ale projekt nie zakłada jej zmiany. Gdybyście wszystkie projekty rozwijali w ramach jednego środowiska, wówczas dość ciężko byłoby tym zarządzać.
Jak na szybko zbudować środowisko wirtualne?
- Stwórz folder na dysku
- Następnie po odpaleniu wiersza poleceń/ cmd wklej poniższą komendę:
cd C:\danesawszedzie
(oczywiście wybierz właściwą ścieżkę do swojego folderu).
3. W kolejnym kroku wykonaj
python -m venv danesawszedzie
Tekst po fladze -m venv oznacza nazwę środowiska. W moim wypadku jest to „danesawszedzie”. Ty możesz oczywiście wybrać dowolną nazwę dla swojego środowiska.
- Po chwili możesz aktywować środowisko, używając poniższej komendy:
.\danesawszedzie\Scripts\activate
5. Zauważysz (danesawszedzie) w nawiasie, przed ścieżką, co świadczy o działaniu właśnie w wirtualnym środowisku.
(danesawszedzie) C:\danesawszedzie>
6. W kolejnych krokach możemy oczywiście instalować biblioteki, niezbędne do naszego projektu.
Tworzenie requirements.txt
Z poziomu środowiska, na którym rozwijaliśmy nasze rozwiązanie (może to być wirtualne środowisko, które stworzyliśmy), wykonujemy w terminalu poniższą komendę:
pip freeze > requirements.txt
Po chwili, w lokalizacji znajdzie się plik requirements.txt, w którym będą wypisane wszystkie biblioteki, wraz z ich wersjami, których użyliśmy.
Kolejna osoba, wystarczy, że w swoim środowisku odpali w terminalu komendę:
pip install -r requirements.txt
(oczywiście plik przez nas wygenerowany musi być w tym miejscu, gdzie odpalamy komendę).
Na koniec, nie zapomnij o deaktywacji środowiska, wystarczy:
deactivate
Voila! Prawda, że przydatne?
Podsumowanie
Jeśli chcesz w szybki sposób zidentyfikować wszystkie biblioteki Pythonowe, których użyłeś w ramach swojego rozwiązania, warto wygenerować plik requirements.txt. Jest to najprostszy sposób na podzielenie się „konfiguracją” bibliotek w rozwiązaniu. Dzięki temu, osoba, której przekazujesz np. swoje skrypty Pythonowe w łatwy i szybki sposób jest zainstaluje, a Wy razem oszczędzicie dużo czasu na szukaniu brakujących bibliotek. Polecam!