cli_wallet

Консольное приложение "Личный финансовый кошелек"

Оглавление

• Технологии
• Описание работы
• Установка приложения
• Запуск тестов
• Запуск приложения
• Удаление приложения
• Автор

Технологии

Подробнее

⬆️Оглавление

Описание работы:

Данные хранятся в текстовом csv-файле. При первом запуске приложения в текущей директории будет создана папка data и файл data.csv.

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

1. Вывод баланса: Показывает текущий баланс, а также отдельно доходы и расходы.
   Команды: balance /b
2. Добавление записи: Возможность добавления новой записи о доходе или расходе.
   Команды: add /a
3. Поиск по записям: Поиск записей по категории, дате или сумме.
   Команды: search /s
4. Редактирование записи: Изменение существующих записей о доходах и расходах.
   Команды: edit /e
   Также используются команды /u /d для скроллинга вверх-вниз в режиме выбора строки редактирования.
5. Выход из приложения (Смотри ниже):
   Команды: quit /q

Также предусмотрен флаг -d (description - выводит в консоль описание команды). Примеры: /a-d или add-d

⬆️Оглавление

Установка приложения:

1. Клонируйте репозиторий с GitHub:

git clone https://github.com/alexpro2022/cli_wallet.git
cd cli_wallet

2. Создайте и активируйте виртуальное окружение и установите необходимые зависимости::
   • Если у вас Linux/macOS

    python -m venv venv && source venv/bin/activate
    python -m pip install --upgrade pip && pip install -r requirements/test.requirements.txt

   • Если у вас Windows

    python -m venv venv && source venv/Scripts/activate
    python -m pip install --upgrade pip && pip install -r requirements/test.requirements.txt

⬆️Оглавление

Запуск тестов:

Из корневой директории проекта выполните команду:

pytest --cov

⬆️Оглавление

Запуск приложения:

1. Из корневой директории проекта выполните команду:

python main.py

2. Для остановки можно использовать

• либо cli-команду /q (возможно два раза в зависимрсти от уровня вызова команды)
• либо сочетание клавиш Ctrl-C

⬆️Оглавление

Удаление приложения:

Из корневой директории проекта выполните команду:

cd .. && rm -fr cli_wallet && deactivate

⬆️Оглавление

Автор:

Aleksei Proskuriakov

⬆️В начало