added README

egorcoders · egorcoders · commit 0c0a7413818e · 2022-08-04T09:00:37.000+05:00
diff --git a/README.md b/README.md
@@ -1,2 +1,93 @@
-# hw_python_oop
-Sprint 2. Итоговый проект.
+# Модуль расчёта денег и калорий
+
+Яндекс Практикум. Спринт 2. Итоговый проект.
+
+## Описание
+
+Модуль представляет собой калькуляторы подсчёта денег и калорий на основе записей пользователя.
+
+## Класс записей пользователя
+
+```python
+class Record
+```
+
+### Свойства класса записей
+
+* amount - количество потребляемых калорий или потраченных денег;
+* comment - коментарии пользователя;
+* date - дата записи;
+
+### Пример создания экземпляра класса
+
+```python
+r1 = Record(amount=122, comment='Хороший шопинг', date='09.04.2019')
+```
+
+## Родительский класс калькулятора
+
+```python
+class Calculator
+```
+
+### Свойства класса калькулятора
+
+* limit - максимально допустимое количество потребляемых калорий или потраченных денег;
+* records - словарь, содержащий все записи пользователя;
+
+### Методы класса калькулятора
+
+* `get_today_date()` - метод возвращает текущую дату;
+* `get_week_date()` - метод возвращает текущую неделю;
+* `add_record(record)` - метод принимает на вход новую запись `record` и добавляет её в словарь `records`;
+* `get_today_stats()` - метод возвращает сумму расходов на сегодня;
+* `get_week_stats()` - метод возвращает сумму расходов за неделю;
+* `get_today_limit()` - метод возвращает лимит расходов на сегодня;
+
+## Наследники класса калькулятора
+
+### Класс калькулятора денег
+
+```python
+class CashCalculator
+```
+
+### Свойства класса калькулятора денег
+
+* limit - максимально допустимое количество потраченных денег;
+* records - словарь, содержащий все записи пользователя;
+
+### Константы класса калькулятора денег
+
+* `USD_RATE` - курс доллара к рублю, USD/RUB;
+* `EURO_RATE` - курс евро к рублю, EUR/RUB;
+
+### Методы класса калькулятора денег
+
+* `get_today_cash_remained(currency)` - метод принимает на вход `currency` - ключ словаря `currencies` курсов валюты и возвращает сообщение о состоянии дневного баланса в указанной валюте, округляя значение типа float до 2 знаков после запятой:
+  * *«Указана неверная валюта. Повторите ввод.»*, если вводимая `currency` отсутствует в `currencies`;
+  * *«Денег нет, держись»*, если лимит достигнут;
+  * *«На сегодня осталось N руб/USD/Euro»* — в случае, если лимит `limit` не достигнут;
+  * *«Денег нет, держись: твой долг - N руб/USD/Euro»*, если лимит превышен;
+
+```python
+# базовая формула расчета
+лимит_расходов_на_сегодня / курс_валюты
+```
+
+### Класс калькулятора калорий
+
+```python
+class CaloriesCalculator
+```
+
+### Свойства класса калькулятора калорий
+
+* limit - максимально допустимое количество потребляемых калорий;
+* records - словарь, содержащий все записи пользователя;
+
+### Методы класса калькулятора калорий
+
+* `get_calories_remained()` - метод возвращает сообщение, в зависимости от значения `limit`:
+  * *«Сегодня можно съесть что-нибудь ещё, но с общей калорийностью не более N кКал»*, если лимит не достигнут;
+  * *«Хватит есть!*, если лимит превышен;
