1. Home (ru)

Добро пожаловать в spb вики!

---

spb - Simple Progress Bar ("Простой Прогресс Бар")

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

Индикаторы, которые могут быть отображены:

• индикатор прогресса (выполнения)
• индикатор процентов
• индикатор времени (таймер)
• индикатор скорости передачи данных
• индикатор количества переданных данных

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

Как установить:

Из PyPI и находясь внутри вашего виртуального окружения (venv):

pip3 install spb

Из исходников:

В качестве альтернативы вы можете установить spb из каталога источников:

git clone https://github.com/patsuckow/spb
cd spb
pip3 install -r requirements.txt
pip3 install . --user
cd ..
rm -rf spb

Как импортировать в свой проект:

from spb import SimpleProgressBar as spb

Требования:

Указаны в файле requirements.txt

Внутри себя spb подключает:

• import sys
• import time
• import shutil
• from typing import Union
• from collections import deque

spb работает с or higher.

Лицензия:

Примеры:

Базовые примеры:

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

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

• Базовый пример №1 (установка минимального колва параметров):
• Базовый пример №2 (с настройкой некоторых параметров, которые вам нужны):
• Базовый пример №3 (с настройкой некоторых параметров, которые вам нужны):
• Базовый пример №4 (начать прогресс бар не с нуля циклов (процентов)):
• Базовый пример №5 (с уменьшением индикатора выполнения не с нуля циклов (процентов)):

Другие варианты настроек (variant_brackets, variant_arrow и variant_space) можно найти здесь.

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

Как используются индикатор загрузки файла и индикатор выполнения (тип индикатора будет зависеть от установленных вами настроек):

• Пример использования № 1 (Скачать один файл с помощью модуля requests):
• Пример использования № 2 (Скачать файлы из списка URL по одному с помощью модуля requests).
• Пример использования № 3 (Скачать файлы из списка URL-адресов один за другим, используя urllib3).
• Пример использования № 4 (Загрузка нескольких файлов (параллельная / массовая загрузка) с использованием модуля requests).
• Пример использования № 5 (Скачать видео с YouTube с помощью модуля pytube):
• Пример использования № 6 (Скачать плейлист с YouTube с помощью модуля pytube).
• Пример использования № 7 (Загрузите один файл или все файлы из папки Google Drive с помощью google-api-client).
• Пример использования № 8 (Загрузите с Google-диска, используя модуль requests и не используя google-api-client):

Документация:

Все возможные настройки (параметры) можно найти этой странице - parameters.

Тесты:

Unit-тесты - test_spb.py

Запустить тесты:

python3 -m unittest discover

Примечания:

1. Значения Unicode-символов, которые можно использовать для параметров, можно взять из таблицы Unicode. Вы можете скопировать символы Юникода, например, с этого сайта: https://unicode-table.com/ru/

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

Содействие:

Отправка issues

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

Написать код

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

Распространение

Если у вас есть какие-то советы и рекомендации или какие-либо другие слова по поводу данного модуля, которые, по вашему мнению, могут быть интересны для других - публикуйте их там, где вам удобно.

Помочь в развити проекта

Если вы захотите помочь в развитии проекта или просто отблагодарить автора, это можно сделать через PayPal: https://www.paypal.me/patsuckow

Смотрите также: https://pypi.org/project/spb/