Как создавать и публиковать консольные приложения на Python

Python

Консольные приложения — это те, которые вы запускаете в терминале. Скорее всего, вы уже пытались их создать. Или, по крайней мере, думали об их создании.

Но создание консольного приложения — это одно, а публикация его в репозиторий с открытым кодом (например, PyPI) — совсем другое. Хотя ни первое, ни второе не является чем-то запредельно трудным.

В этой статье я подробно расскажу, как можно создать простой CLI на Python и опубликовать его в PyPI.

Начало

Не так давно я занялся изучением уязвимостей open-source кода и понял, что хочу иметь в арсенале инструмент командной строки, который мог бы находить уязвимости напрямую из терминала. Уязвимости open-source кода обычно публикуются в открытых базах данных. Их можно найти на таких сайтах, как CVE, NVD, WhiteSource Vuln и т.д.

В этой статье мы создадим примитивный скрейпер для поиска и просмотра уязвимостей с сайта CVE, обернем его в простое консольное приложение и опубликуем на PyPI.

Для начала нужно настроить среду разработки и установить необходимые модули. Я предлагаю установить виртуальную среду. Это простое решение, которое позволит избежать конфликтов между версиями модулей.

Для создания виртуальной среды можно воспользоваться командой python -m venv <path/name> (для Python 3) либо установить virtualenvwrapper с помощью pip install virtualenvwrapper и создать виртуальную среду virtualenv через mkvirtualenv -p /path/topython <path/name> .

После того, как виртуальная среда настроена и активирована, вы можете создать папку проекта и установить необходимые модули:

Как только все успешно запустилось, откройте свой проект в любом редакторе кода. Вы увидите похожую структуру:

Создание веб-скрейпера

Для того, чтобы искать и просматривать уязвимости на сайте CVE, потребуется веб-скрейпер. Он поможет нам собирать информацию об уязвимостях. Мы создаем скрейпер в Requests и BeautifulSoup. Вот что будет делать наш скрейпер:

1. искать уязвимости;

2. получать информацию об уязвимости по ее названию на CVE.

Теперь откроем папку cver и создадим в ней файл под названием cve_scraper . Затем пропишем его базовые настройки:

Поиск уязвимостей

Для поиска уязвимостей на CVE используется URL в следующем формате: https://cve.mitre.org/cgi-bin/cvekey.cgi?keyword=<ключевое_слово> . Такой формат позволяет извлекать список уязвимостей, соответствующих ключевому слову.

Например, через URL можно получить список всех уязвимостей, связанных с Python:

Для извлечения данных открываем инструменты разработчика ( Developer Console ) и исследуем DOM-элемент с нужным представлением. Для этого кликните правой кнопкой по любому месту на странице и выберите “исследовать элемент” ( inspect element ) либо нажмите Ctrl + F12 .

Если вы присмотритесь к DOM-структуре выше, то увидите, что результаты представлены в виде таблицы, а каждое значение указано в отдельной строке под таблицей. Такие данные можно запросто извлечь:

1. отправляем запрос в SEARCH_URL с помощью Requests и получаем DOM-содержимое;

2. преобразуем DOM-содержимое в объекты BeautifulSoup . Это позволит нам выделять DOM-элементы с помощью CSS-селекторов, XPATH и других методов;

3. выделяем все tr под таблицей #TableWithRules . Выделяем первый столбец строки в качестве названия, а в качестве описания берем второй. Затем извлекаем текст.

Просмотр информации об уязвимостях

Чтобы просмотреть информацию об уязвимости, нужно взять ее CVE-ID и передать по этому адресу: https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-ID.

Откройте инструменты разработчика и исследуйте DOM-структуру.

Такая структура чуть сложнее, поскольку в строках таблицы отсутствует ID или название класса. Поэтому нам нужно пройтись циклом по каждой строке и проверить, не является ли она подзаголовком. Если да, то следующий элемент берется в качестве содержимого-потомка. Каждый подзаголовок отображается в th , а его содержимое — в td .

Готово! Мы успешно создали веб-скрейпер с CVE. Теперь добавим в него две функции ( search и lookup_sve ), которые будут искать уязвимости и получать информацию по ним через CVE-ID .

Создание консольного приложения

Наш следующий шаг — структурирование и создание консольного приложения через библиотеку Click.

Click — это Python-пакет для создания красивых интерфейсов командной строки с минимальным количеством кода и возможностью компоновки. Это один из лучших Python-пакетов для создания CLI, и с ним очень удобно работать.

Читайте так же:

Загрузочный диск windows 10 для восстановления системы

Click позволяет создавать интерфейсы командной строки любого уровня — от самых простых до навороченных (например, Heroku).

В нашем CLI мы реализуем две команды:

1. поиск уязвимости;

2. просмотр уязвимости.

В папке cver создаем файл под названием __main__.py и прописываем его базовые настройки:

Поиск уязвимостей

Здесь мы будем импортировать функцию поиска search из веб-скрейпера и передавать ей аргумент keyword из командной строки. Таким образом, приложение будет искать уязвимости, совпадающие с ключевым словом:

Для запуска этой команды:

Просмотр уязвимости

Принцип тот же: используем lookup_cve из веб-скрейпера и передаем туда аргумент name из команды look_up .

Для запуска этой команды:

Готово! Мы успешно создали инструмент командной строки по поиску с CVE.

Публикация консольного приложения на PyPI

После того, как мы создали консольное приложение и убедились в его работоспособности, можно опубликовать его на PyPI в публичном доступе.

PyPI — это хранилище приложений для пакетов Python. Там можно найти практически все пакеты, которые устанавливаются через pip . Для публикации пакета потребуется аккаунт на PyPI. Если он у вас уже есть, то смело читайте дальше.

Настройка пакета

Следующий шаг — это настройка Python-пакета с помощью setup.py . Если вы хотите, чтобы ваш пакет попал на PyPI, то нужно снабдить его базовым описанием. Эта информация указывается в файле setup.py .

Откройте setup.py в основной директории проекта и поместите в начало файла следующий код:

В примере выше мы преобразовали содержимое файла README.md в одну строку для дальнейшего использования. Кроме того, мы перечислили все необходимые модули из requirements.txt и сгенерировали ссылки на их зависимости.

Ваш файл requirements.txt выглядит примерно так:

Теперь давайте рассмотрим параметры настроек:

В коде выше мы добавили множество строк. Но подробнее обсудим только те из них, которые нужны для установки.

1. name — название пакета, которое появится на PyPI;

2. version — текущая версия пакета;

3. packages — пакеты и подпакеты с исходным кодом. В ходе установки мы пользуемся модулем find_packages . Он автоматически находит все подпакеты;

4. install_requires — используется для перечисления всех зависимостей или сторонних библиотек пакета. В cver мы пользуемся Requests, Beautifulsoup 4 и Click. Их нужно включить в требования к установке install_requires . Нам не нужно добавлять эту информацию вручную, поскольку она присутствует в requirements.txt ;

5. entry_points — используется для создания скриптов, которые вызывают функцию внутри пакета. В данном случае мы создаем новый скрипт cver , который вызывает main() внутри файла cver/__main__.py . Наш основной элемент — это __main__.py , который вызывает функцию main() для запуска Click.

До того, как опубликовать пакет на PyPI или выложить в открытый доступ, необходимо снабдить его документацией. То, как будет выглядеть документация, целиком и полностью зависит от самого проекта. Это может быть как простой файл README.md , так и Readme.rst .

Пример хорошо оформленного README.md :

Кроме того, не забудьте создать файл .gitignore :

Публикация на PyPI

Теперь ваш пакет готов к публикации на PyPI. Еще раз проверьте, есть ли у вас уже аккаунт на PyPI. Добавьте к нему тестовый аккаунт на тестовом сервере PyPI. Этот аккаунт нужен для тестирования пакетов перед публикацией их на рабочем сервере.

Загружать Python-пакеты на PyPI мы будем с помощью специального инструмента — Twine. По идее, вы уже установили его на одном из предыдущих этапов. Если нет, то это можно сделать через pip install twine .

Создание и локальное тестирование пакета на тестовом сервере

Python-пакеты, опубликованные на PyPI, не распространяются в виде «голого» кода. Они оборачиваются в дистрибутивы. Самыми распространенными форматами дистрибутивов в Python являются Wheels и Source Archives.

Wheels — это zip-архив с кодом и готовыми расширениями. Source Archives содержит исходный код и вспомогательные файлы, упакованные в tar-архив.

Для локального тестирования пакета выполните:

Теперь мы можем использовать его как:

Для проверки пакета на тестовом сервере PyPI нужно сгенерировать сборку для локального тестирования. При создании этой сборки сгенерируются архивы Wheels и Source Archives.

Код ниже сгенерирует два файла в директории dist :

Затем воспользуемся Twine. Теперь мы можем загрузить пакет на тестовый сервер PyPI:

Читайте так же:

Записать загрузочную флешку windows 7 ultraiso

Затем у вас спросят логин и пароль.

Если пакет загружается на тестовый сервер без ошибок, то он готов к публикации на рабочем сервере. Проверить можно здесь.

Для установки из TestPyPI выполните следующую команду:

В тестовой среде вы можете проверить все команды и убедиться в их правильности перед публикацией пакета на рабочем сервере.

Протестировав все команды локально, переходите к публикации пакета на рабочем сервере:

В процессе загрузки укажите свой логин и пароль. Вот и все!

Теперь пакет можно установить через:

Поздравляю! Ваш пакет был опубликован на PyPI. Просмотреть его можно здесь!

Заключение

В этой статье я пошагово объяснил процесс создания и публикации консольного приложения на Python.

Аргументы командной строки с Python и sys.argv

Часто, при запуске программ Python через командную строку, возникает необходимость передачи дополнительных аргументов. Например, если программа обрабатывает данные, считанные из файла, вы можете передать имя файла своей программе, а не жестко кодировать значение в исходном коде. Для этого, можно использовать функцию input(), что не всегда удобно. Гораздо удобнее, было бы передать параметры непосредственно при запуске, после имени сценария.

Python предоставляет механизм для захвата и извлечения аргументов командной строки. Эти значения, затем, можно использовать для изменения поведения программы.

Их можно использовать посредством модуля sys, используя в коде программы sys.argv. И перейдем к примеру:

# создадим файл test.py

# импортируем модуль
import sys

# отобразим список аргументов командной строки
print('Список аргументов:', str(sys.argv))

# и количество аргументов
print('Число аргументов', len(sys.argv))

Теперь, запустим файл test.py вместе с аргументами:

>>>python test.py 1 2 3 4 5

Как можно заметить, первый элемент в списке это название самого скрипта. И чтобы получить лишь список аргументов, без названия скрипта, используем следующий вариант кода:

Получив представление о sys.argv, можно манипулировать данными переданными в командной строке. Попробуем перевернуть буквы в слове:

# запуск
>>>python reverse.py myrusakov

Таким образом, добавление возможности обработки аргументов командной строки Python способно обеспечить удобный интерфейс для нашей программы. Это похоже на то, что представляет собой графический пользовательский интерфейс для визуального приложения.

Копирование материалов разрешается только с указанием автора (Михаил Русаков) и индексируемой прямой ссылкой на сайт (http://myrusakov.ru)!

Добавляйтесь ко мне в друзья ВКонтакте: http://vk.com/myrusakov.
Если Вы хотите дать оценку мне и моей работе, то напишите её в моей группе: http://vk.com/rusakovmy.

Если Вы не хотите пропустить новые материалы на сайте,
то Вы можете подписаться на обновления: Подписаться на обновления

Если у Вас остались какие-либо вопросы, либо у Вас есть желание высказаться по поводу этой статьи, то Вы можете оставить свой комментарий внизу страницы.

Порекомендуйте эту статью друзьям:

Если Вам понравился сайт, то разместите ссылку на него (у себя на сайте, на форуме, в контакте):

Она выглядит вот так:

Комментарии ( 0 ):

Для добавления комментариев надо войти в систему.
Если Вы ещё не зарегистрированы на сайте, то сначала зарегистрируйтесь.

Tkinter в Python: руководство по использованию

Tkinter — графическая библиотека Python, которая предназначена для создания программ с оконным интерфейсом. Она кроссплатформенная, то есть с ее помощью можно писать приложения для Windows, Linux, macOS.

Tkinter

Как я поделился своими чувствами, что познал вселенную Tkinter

Tkinter в Python

Tkinter — это интерфейс Tcl/Tk. На английском его обычно называют «тикль-ток», на русском — «так-тикль».

Tcl — это скриптовый язык. Tk — кроссплатформенная графическая библиотека.

Область применения Tcl/Tk — быстрое прототипирование. С его помощью создают графические интерфейсы, встраивают новые сценарии в программы, тестируют.

Чтобы работать с Tcl/Tk на Python, используется библиотека Tkinter. Чтобы узнать больше о том, как с ней взаимодействовать, изучите документацию.

Удобство Tkinter в том, что она входит в стандартный набор Python. Если в системе установлен Python, то Tkinter тоже работает. Проверить это можно командой python -m tkinter .

В результате должно запуститься окно, в котором указана версия Tcl/Tk, а также две кнопки — Click me и Quit.

Создание простого GUI приложения на Tkinter

В этом руководстве мы будем писать первое приложение на Tkinter в среде Windows. В качестве IDE используем Visual Studio Code. Подразумевается, что вы владеете основами Python. Все примеры кода написаны на Python 3.9.

Читайте так же:

Забыл пароль от учетки windows 7

Установка Tk

Прежде чем использовать библиотеку Tkinter, нужно убедиться, что в системе стоит последняя версия Tk. В противном случае могут возникнуть ошибки при компиляции.

Если в системе уже установлен Python, проверьте версию Tcl/Tk командой python -m tkinter .

Вам нужна версия 8.6 и выше. Если в системе установлена версия 8.4 или 8.5, нужно ее обновить. Самый простой способ сделать это — установить одну из последних версий Python. Начиная с версии 3.7 в ядре Python предустановлен Tcl/Tk версии 8.6.

Перейдите на сайт python.org.
Откройте раздел Downloads.
Убедитесь, что сайт правильно определил версию вашей ОС. Если вам нужен установщик Python для другой операционной системы, выберите ее из перечня.
Нажмите кнопку Download Python.
Запустите скачанный файл.
Нажмите Install now и дождитесь завершения установки.

После завершения установки запустите консоль и проверьте, какая версия Python используется по умолчанию. Должна быть 3.7 и выше. Если версия отличается, переключитесь на установленную ранее.

Hello, World!

Начнем традиционно — поздороваемся с миром. Для этого сделаем простое окно, у которого будет только заголовок.

Создайте файл my_app.py и напишите в нем:

Обратите внимание на функцию mainloop() . Она вызывает бесконечный цикл. Окно будет ждать любого действия от пользователя до тех пор, пока пользователь его не закроет. Без mainloop() окно не отобразится.

Запускаем файл в консоли командой python my_app.py

Откроется окно вашей первой программы с заголовком Hello, World !

Особенность Tkinter в том, что библиотека автоматически подстраивает внешний вид окна под стиль операционной системы. Так окно выглядит на Windows. На Linux и macOS оно будет другим, соответствующим стилю системы.

Источник изображения: python-scripts.com/tkinter

Базовые виджеты

Виджеты — это основа библиотеки Tkinter. Через них пользователи взаимодействуют с программой.

Каждый виджет определен классом. Вот основные семь:

Класс виджета	Что делает	Пример использования
Frame	Помогает организовать пользовательский интерфейс как визуально, так и на уровне кода. Отображается как простой прямоугольник.	Разделение интерфейса на блоки.
Label	Виджет для отображения текста или изображения. Пользователи могут его просматривать, но не могут взаимодействовать с ним.	Заголовки, подписи, иконки в интерфейсе.
Button	Это элемент интерфейса, с которым пользователи могут взаимодействовать. На кнопку нажимают, чтобы выполнить действие. Button может отображать текст и изображение, как и Label, но также может принимать дополнительные параметры для изменения поведения.	Кнопки в интерфейсе: для перехода, сохранения, выхода из программы.
Checkbutton	Разновидность кнопки, которая содержит двоичное значение. При нажатии переключатель переворачивается, затем происходит обратный вызов.	Включение и выключение опций с помощью галочек.
Radiobutton	Кнопка, которая позволяет выбрать один из нескольких взаимоисключающих вариантов.	Список с опциями, например, для выбора языка интерфейса.
Entry	Виджет для ввода одной строки текста.	Указание имени, пароля, города и других данных пользователей.
Combobox	Объединяет Entry со списком опций. Пользователи могут выбирать из предложенных вариантов или указывать свои.	Выпадающий список.

Это лишь базовые виджеты. Посмотреть их подробное описание можно в официальной документации Tk. Там же есть и другие стандартные виджеты — например, скроллбар, шкала прогресса, список.

Управление геометрией

Для управления геометрией используются менеджеры. Самый популярный — grid() . Он превращает окно или фрейм в сетку, разделяя пространство на строки и столбцы.

Чтобы указать место виджета, достаточно передать индексы row и column . Индексы начинаются с 0 .

Например, вот так просто можно разместить три кнопки в ряд:

В grid() также можно гибко управлять размерами виджетов при расширении и уменьшении окна.

Еще один менеджер геометрии — pack() . Он размещает виджеты в определенном порядке. Это происходит в два этапа:

Расчет участка — прямоугольной области, в которую будет помещен виджет. После размещения виджета на участке оставшееся пространство заполняется пустотой.
Центрирование виджета в участке, если не указаны иные параметры.

По умолчанию pack() размещает виджеты друг над другом и центрирует. Настроить расположение элементов можно с помощью ключевых аргументов. Например, вот так можно расширить виджет по горизонтали на всю ширину экрана:

Примечательно, что pack() реагирует на расширение экрана. То есть виджет будет растягиваться и сворачиваться при изменении ширины окна.

Читайте так же:

Запуск windows игр на linux

Управлять направлением виджетов можно с помощью аргумента side . Он принимает следующие параметры:

tk.TOP — наверх;
tk.BOTTOM — вниз;
tk.LEFT — налево;
tk.RIGHT — направо.

Например, вот так можно развернуть наши виджеты налево:

Третий менеджер геометрии — place() . Он нужен для точного указания местоположения виджета. В place() вам нужно определить координаты x и y для верхнего левого угла. Они измеряются в пикселях.

Менеджер place() используется все реже. У него два недостатка:

Сложно настраивать макет, особенно если виджетов много.
Макеты не адаптируются под размер окна.

Но в некоторых случаях place() подходит — например, если нужно создать интерфейс для географической карты и разместить виджеты на правильном расстоянии друг от друга.

У pack() тоже есть недостаток. Так как расположение виджетов зависит от порядка вызова метода, приложения сложно модифицировать без полного понимания кода. В grid() эти проблемы решены, поэтому он сейчас используется чаще, чем другие менеджеры геометрии. Больше полезной информации о менеджере grid() вы найдете в документации.

Примеры использования виджетов

Чтобы лучше понять концепцию создания и размещения виджетов, давайте разберем несколько примеров.

Здесь мы добавляем текст с помощью виджета Label и кнопку с помощью виджета Button :

Получаем вот такой результат:

Пока наша кнопка ничего не делает, давайте это исправим. Добавим функцию, которая меняет текст Label , и навесим ее на кнопку:

Теперь после нажатия на кнопку текст Label будет меняться на тот, который мы указали внутри функции:

Теперь добавим в свою программу чекбоксы:

Мы получим такой результат:

Так же просто можно добавлять и конфигурировать виджеты других типов, выстраивая интерфейс приложения по кирпичикам.

Пишем простой калькулятор

Используем полученные знания, чтобы написать первое приложение на Tkinter. Пусть это будет очень простой калькулятор, который умеет совершать основные математические операции: складывать, вычитать, умножать, делить. У него также будет кнопка очистки для удаления введенных или выведенных данных.

Стандартное начало — импорт модуля Tkinter , создание окна и добавление заголовка. Создайте файл calculator.py и напишите:

Определим базовое расположение элементов калькулятора. Начнем со строки, в которую пользователь вводит цифры. В ней же отображается результат расчетов:

Теперь создадим все кнопки, которые нужны нашему калькулятору. Цифры от 1 до 0, знаки сложения, вычитания, деления, умножения, кнопки вывода результата и очистки строки:

Теперь нужно расположить кнопки в интерфейсе, используя менеджер геометрии grid :

Осталось определить логику для каждого действия пользователя : нажатия на цифру, знаки математических операций:

Чтобы пользователь мог взаимодействовать с программой, добавьте в конце root.mainloop() .

Запустите файл calculator.py . На экране появится окно программы:

Это очень простой калькулятор. Но он уже работает так, как нужно. Его можно усовершенствовать — добавить дополнительные функции, изменить внешний вид, настроить ввод с клавиатуры.

Полный код приложения:

Заключение

Чтобы потренироваться с Tkinter, создайте еще несколько простых приложений. В качестве руководства можно использовать это видео от freeCodeCamp. Это мини-курс по Tkinter, в рамках которого вы создадите программу для просмотра картинок. Это будет минималистическое приложение для погоды.

А с этого видео начинается курс по Trinter на русском языке. В нем 28 уроков, вторая половина которых посвящена созданию игры «Сапер» на Python.

Highload нужны авторы технических текстов. Вы наш человек, если разбираетесь в разработке, знаете языки программирования и умеете просто писать о сложном!
Откликнуться на вакансию можно здесь .

Как запустить скрипт Python без появления консоли Windows

Есть ли какой-нибудь способ запустить сценарий Python без мгновенного появления команды shell? Именование моих файлов с расширением «.pyw» не работает.

EDIT: проблема решена с помощью ShellExecute()

4 ответа

Python скрипт всплывает в консоли при запуске планировщиком

Возможный Дубликат : Запустите скрипт python без появления DOS shell У меня есть сценарий python, который планировщик Windows запускает для меня каждые 5 минут. Скрипт работает нормально, но каждый раз, когда он запускается, он очень быстро загружает консоль на мой рабочий стол, прежде чем она.

Есть ли способ запустить непосредственно скрипт python в консоли windows, например в системе Unix? #! /usr/bin/env python3.3

Читайте так же:

Заработок на виндовс фон

Попробуйте запустить скрипт с помощью исполняемого файла Python pythonw.exe .

В Windows OSes исполняемые файлы, являющиеся консольными приложениями ( python.exe без w -консольное приложение), запускаются с отображением окна консоли; с другой стороны, обычные приложения Windows не порождают это черное окно консоли.

Вы можете найти подробную информацию об этих двух исполняемых файлах в этом старом вопросе: pythonw.exe или python.exe?

И о Windows различных типах приложений здесь: Разница между Windows и консольным приложением

Во всех установках python с 2.5 (и, возможно, ранее), если установка была выполнена правильно, файлы .py связаны с python.exe , а файлы .pyw связаны с pythonw.exe

Если ассоциации были изменены или переопределены для конкретного пользователя, это может быть по-другому.

Выполните следующую команду в cmd:

Если у вас этого нет, вы можете сделать несколько вещей, чтобы исправить это:

re-install/repair python установка (запустите установщик, он предложит восстановить установку)

если вы не являетесь администратором своей машины, вы можете связать .pyw файлов с pythonw.exe . Небольшая проблема с этим, вам придется впоследствии изменить раздел реестра, чтобы добавить дополнительные аргументы, или удаление параметра в файле .pyw не будет учитывать его (он редко используется, но все же)

[HKEY_CLASSES_ROOTPython.NoConFileshellopencommand] @=»»L:\Portable_Python_2.7.3.1\App\pythonw.exe» «%1″ %*»

Используйте функцию ShellExecuteEx.

Это pExecInfo: ***nShow — Флаги, указывающие, как должно отображаться приложение при его открытии

Простой ответ-скопировать «LazyLibrarian.py» в «LazyLibraryian.pyw» и создать ярлык на рабочем столе. Затем поместите ярлык в папку автозагрузки.

Как запустить скрипт python в фоновом режиме windows?

У меня есть сценарий python, который работает на сервере windows Server 2008 в строке cmd. Мне не нужно никакого взаимодействия во время выполнения скрипта. Кстати, сценарий работает уже около недели. Поэтому, если сервер по какой-то причине отключает мое соединение, мой скрипт останавливается, и.

Я хочу запустить скрипт python перед выключением system.I использую Windows 7.I запустил скрипт python при запуске системы, но я не могу запустить скрипт перед выключением. Я имею в виду, как запланировать выполнение задачи при выключении windows и многих других подобных вопросов на SO, но.

Как создавать и публиковать консольные приложения на Python