README.md

О проекте

CLI таймер создан с целью контролирования своего времени и измерения полезности его проведения. У самой программы есть много полезных функций, например:

1. Создание таймеров
2. Запуск таймеров
3. Обнуление таймеров
4. Удаление таймеров
5. Вывод информации обо всех таймерах сразу
6. Получение диаграммы с соотношением всех таймеров после выхода из программы
7. Запись полученной диаграммы соотношений времени в png файл
8. Запись результатов работы программы в файл

Зависимости

Проект как зависимости использует:

Пакетный менеджер: poetry

Библиотеки python: pandas, matplotlib

Увидеть зависимости проекта вы можете в файлах: pyproject.toml, requirements.txt

Настройка через poetry (pyproject.toml)

После скачивания проекта с github (командой в терминале: git clone https://github.com/DarkPythons/Timer-Python.git), вы должны перейти в каталог проекта.

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

poetry install

poetry shell

cd programm

poetry run python main.py

Настройка через pip (requirements.txt)

После скачивания проекта с github (командой в терминале: git clone https://github.com/DarkPythons/Timer-Python.git), вы должны перейти в каталог проекта.

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

python -m venv .venv

cd .venv/scripts

activate.bat

cd ../../

pip install -r requirements.txt

cd programm

python main.py

Настройка через специальные файлы

После скачивания проекта с github (командой в терминале: git clone https://github.com/DarkPythons/Timer-Python.git), вы должны перейти в каталог проекта.

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

Windows: Timer-Python/windows_start_program.bat

Linux: Timer-Python/linux_start_program.sh

Эти файлы устанавливают пакетный менеджер poetry, после чего, сам пакетный менеджер создает среду, устанавливает зависимости и запускает программу, которая находится по пути:

Timer-Python/programm/main.py

Что вы должны увидеть после запуска программы (programm/main.py):

Конфигурация (Timer-Python/programm/config.py)

Можно сделать специальную настройку под себя таких параметров как:

1. Использование текста, где будут использоваться смайлики при общении с пользователем (по умолчанию False)
2. Задержка между действиями пользователя (по умолчанию 1.8 секунды)
3. Текст при ожидании загрузки (по умолчанию ".")

Примеры команд и их вывода

Получение справки по командам (команда help (или h))

Получение информации по всем таймерам в виде таблицы (команда info all (или ia))

Получение списка всех таймеров в виде списка (команда ls (или list))

Выход из программы (команда q (или quit))

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

1. Вывести диаграмму, которая выводит соотношение времени, которое было насчитано таймерами
2. Сохранить эту выведенную диаграмму в виде png файла
3. Сохранить результат работы всех таймеров в виде таблицы в текстовый файл

1) Пример диаграммы, которая выводится пользователю

2) Пример уже сохраненной диаграммы в виде png файлa по пути, который стоит по умолчанию

3) Пример результатов работы программы в текстовом файле

Разработчики

• DarkPythons

License

The Python-Timer project is distributed under the GPL-v3 license.