logo

Як створити файл Requirements.txt на Python

Якщо ви розробник, то, напевно, знаєте, що під час роботи над будь-яким проектом Python або проектом з вивчення даних важливо завжди працювати в середовищі, яке робить ваш проект придатним для повторного використання та повторюваності, не створюючи проблем для будь-кого, хто візьме ваш проект. Тож перш ніж обговорювати, як створити файл вимог .txt у Python, дайте нам знати, що таке requirement.txt і навіщо він нам потрібен.

Що таке файл requirement.txt у Python?

в Python вимога.txt файл — це тип файлу, який зазвичай зберігає інформацію про всі бібліотеки, модулі та пакети, які використовуються під час розробки конкретного проекту. Він також зберігає всі файли та пакети, від яких цей проект залежить або потребує запуску. Зазвичай цей файл 'requirement.txt' зберігається (або знаходиться) у кореневому каталозі ваших проектів. Тут виникає ще одне суттєве питання, навіщо нам потрібен цей тип файлів у наших проектах.

Навіщо нам вимога.txt?

Це допомагає нам кількома способами, навіть коли ми переглядаємо наш проект у майбутньому, оскільки вирішує майже всі проблеми сумісності. Якщо ви коли-небудь працювали над будь-яким проектом на Python або розробляли будь-який проект, ви напевно знаєте, що нам зазвичай потрібно кілька пакетів. Але при розробці проекту ми зазвичай використовували певну версію пакетів. Пізніше менеджер пакетів або супроводжувач може внести деякі зміни, і ці зміни можуть легко зламати всю вашу програму. Тому відстежувати кожну модифікацію в пакунках занадто багато роботи. Зокрема, якщо проект надто великий, важливо відстежувати кожен пакет, який ми використовуємо, щоб уникнути несподіваних сюрпризів.

Одним із стандартних способів вирішення подібних проблем є використання віртуального середовища. Причина полягає в тому, що існує два основних типи пакетів і місць, де зазвичай зберігаються бібліотеки Python, і зазвичай нам не потрібні всі типи цих пакетів під час роботи над конкретним проектом; отже, необхідно знати, який з них потрібен для кожного проекту, щоб полегшити відтворюваність.

перетворити рядок на jsonobject java

Зазвичай це стосується таких файлів:

  • Системні пакети, які є частиною стандартної бібліотеки Python
  • Пакети сайту (пакети сторонніх розробників), які ви встановлюєте за допомогою pip.

Що таке віртуальне середовище?

Віртуальне середовище — це тип ізольованого або штучного робочого простору, який зберігає пакети користувача окремо від локальної (або основної) інсталяції системи. Це дозволяє нам створити «віртуальне» ізольоване середовище для кожного проекту Python. Це полегшує кожному проекту бути незалежним від іншого проекту, особливо якщо вони мають однакові залежності. Існують різні пакети, які можна використовувати для створення віртуального середовища. Ось деякі з основних пакетів:

  • virtualenv
  • pipenv

Отже, коли віртуальне середовище створено для нашого проекту, давайте подивимося, як встановити пакунки та бібліотеки. Дуже легко отримати всі необхідні пакети для використання в нашому проекті з віртуальним середовищем. Давайте спочатку подивимося, як використовувати «virtualenv».

A. virtualenv

Це тип бібліотеки, який дозволяє нам створювати віртуальне середовище та використовувати його. Щоб установити virtualenv, дотримуйтеся наведених інструкцій:

1. Відкрийте Cmd, введіть наступну команду та натисніть кнопку введення, як показано на зображенні нижче:

Команда

 pip install virtualenv 

Вихід

Як створити файл Requirements.txt на Python

2. Створення нового робочого каталогу для проекту

Тепер створіть нове віртуальне середовище в каталозі цього проекту, щоб уникнути непотрібних проблем.

Команда

 Python3 -m venv name_of_env 

Вихід

Як створити файл Requirements.txt на Python

3. Тепер, щоб використовувати це щойно створене віртуальне середовище, нам просто потрібно його активувати. Щоб активувати це ізольоване середовище, введіть наступну команду та натисніть кнопку введення, як показано нижче:

Команда

 name_of_envirnmentScriptsactivate 

Вихід

Як створити файл Requirements.txt на Python

Щоб переконатися, що наше нове віртуальне середовище створено, ви можете побачити в підказці, що префікс змінено на назву вашого нового віртуального середовища, як у нашому випадку, ми назвали наше віртуальне середовище «name_of_envirnmnet». Ви також можете перевірити це, відкривши каталог проекту або папку, де буде створено новий каталог із вказаною назвою.

4. Тепер давайте подивимося, як створити файл requirement.txt

Щоб створити файл requirement.txt, буде добре знати, що він містить.

Файли requirement.txt містять усі типи стандартних пакетів і бібліотек, які використовуються в цьому конкретному проекті. Тому цей файл requirement.txt відіграє важливу роль під час розробки будь-яких малих чи великих проектів. Це також допомагає нам зробити наші проекти більш портативними.

За допомогою файлу 'requirement.txt' можна легко уникнути кількох основних проблем. Щоб зрозуміти це більш детально, ви можете розглянути наступний наведений приклад:

приклад:

Припустімо, ви створили новий проект, наприклад програму, сумісну з конкретною версією бібліотеки та пакетів. Таким чином ви чомусь пересилаєте цю заявку своєму другу.

Оскільки ви не використовували файл requirement.txt, можливо, ваша програма не працюватиме належним чином або навіть не запускатиметься в системі вашого друга. Основною причиною цього є те, що всі користувачі не використовують однакову версію бібліотек і пакетів. Однак, якщо ви використовували файл requirement.txt, будь-хто може запускати та використовувати ваш проект або програму, оскільки всі необхідні або використовувані пакети та бібліотеки також указано у формі файлу (requirement.txt) разом із вашим проектом.

У цьому файлі вимог .txt користувач може легко вибирати, зберігати та підтримувати необхідні файли відповідно до своїх вимог.

Як отримати файл Requirements.txt: за допомогою Virtualenv

Тут ми можемо отримати файл requirements.txt. Щоб створити файл requirement.txt, ми можемо використати таку команду:

Команда

 pip3 freeze > requirements.txt 

Вихід

Як створити файл Requirements.txt на Python

Як отримати файл Requirements.txt: за допомогою Pipenv

Pipenv також є чудовим інструментом бібліотеки для створення віртуального середовища, який має кілька цікавих функцій. Ви можете скористатися наведеною нижче інструкцією, щоб отримати файл requirement.txt.

1. Введіть таку команду, щоб установити pipenv

Команда

 pip install pipenv 

Вихід

Як створити файл Requirements.txt на Python

2. Тепер введіть наступну команду та натисніть кнопку введення.

Команда

 pipenv install mypackage 

Наведена вище команда використовується для встановлення пакетів, необхідних для проектів.

Вихід

Як створити файл Requirements.txt на Python
  • Після встановлення пакетів для проекту нам потрібно активувати віртуальне середовище. Тому для активації віртуального середовища ви можете використовувати наступні команди:

Команда

 pipenv shell 

Або

 pipenv run 

Ці команди можна використовувати для активації новоствореного віртуального середовища, як показано нижче:

Вихід

Як створити файл Requirements.txt на Python

Тепер введіть таку команду, щоб запустити сценарій у віртуальному середовищі.

Команда

 pipenv run Python myscript.py 

Пояснення

Ця команда використовується для запуску зазначеного сценарію у віртуальному середовищі, як показано нижче:

Вихід

Як створити файл Requirements.txt на Python

Оскільки це простіше, він також автоматично відстежує всі бібліотеки, які використовуються для проекту, у pipfile та pipfile. файл блокування. Ці файли відіграють ту саму роль, що й requirements.txt, а також зберігають додаткову інформацію про кілька речей, які не включені в requirement.txt.

Таким чином, ви можете використовувати цей pip-файл як альтернативу файлу requirements.txt. Однак, якщо ви все одно бажаєте використовувати файл requirements.txt, ви можете скористатися такою командою:

 pipenv -r lock >> requirements.txt 

Вихід

Як створити файл Requirements.txt на Python

Як отримати файл Requirements.txt: без Virtualenv за допомогою Pipreqs

Pipreqs є один із найефективніших і простих у використанні інструментів, який не потребує створення віртуального середовища. Тому це дуже корисно, якщо користувачеві потрібні лише пакети та бібліотеки, які використовуються в програмі чи проекті.

Однією з найважливіших речей є те, що він автоматично сканує сценарії або файли Python на наявність їхніх імпортованих бібліотек і генерує requirements.txt.

Давайте подивимося, як це працює:

1. Перш за все, вам потрібно встановити «pipreqs», щоб завантажити його, введіть таку команду в cmd і натисніть кнопку Enter:

Команда

 pip install pipreqs 

Вихід

Як створити файл Requirements.txt на Python

2. Після завершення інсталяції ви можете запустити «pipreqs», щоб отримати файл requirement.txt, вказавши його на теку, де знаходиться папка вашого проекту.

Команда

 pipreqs /path/to/project 

Вихід

Як створити файл Requirements.txt на Python

Щоб переконатися, що файл requirement.txt створено успішно, ви можете побачити в папці вашого проекту, що буде створено новий файл 'requirement.txt', як показано нижче:

Як створити файл Requirements.txt на Python