Merge pull request #9 from W-A-L-L-3/develop

v1.1.0

Author: Yu-Leo

README.md

@@ -1,109 +1,201 @@
 # Электронный склад
 
-Московская предпрофессиональная олимпиада школьников.
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/Django)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/W-A-L-L-3/electronic-storehouse)
+![GitHub last commit](https://img.shields.io/github/last-commit/W-A-L-L-3/electronic-storehouse)
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/W-A-L-L-3/electronic-storehouse)
+![GitHub](https://img.shields.io/github/license/W-A-L-L-3/electronic-storehouse)
 
-Профиль "Информационные технологии".
+[Московская предпрофессиональная олимпиада школьников.](http://predprof.olimpiada.ru/)
 
-Командный кейс №5 "Электронный склад"
+[Профиль "Информационные технологии".](http://predprof.olimpiada.ru/it)
 
-[Исходный текст технического задания](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/technical-requirements.pdf)
+**Командный кейс №5 "Электронный склад".**
+[Исходный текст технического задания](docs/technical-requirements.pdf)
 
-## Кратное описание
+## Навигация
 
-Информационный сервис обеспечивающий взаимодействие пользователей (операторов) с автоматизированным складом.
+* [Описание проекта](#chapter-0)
+* [Как начать](#chapter-1)
+* [Интерфейс приложения](#chapter-2)
+* [Ошибки](#chapter-3)
+* [Код](#chapter-4)
+* [Авторы](#chapter-5)
+* [Лицензия](#chapter-6)
 
-## Функциональность
+<a id="chapter-0"></a>
+
+## Описание проекта
+
+Информационный сервис, обеспечивающий взаимодействие пользователей (операторов) с автоматизированным складом.
+
+[Техническая документация](docs/technical-documentation.pdf)
+
+### Функциональность
 
 1. Добавление нескольких позиций из поставки на склад.
-2. Отображение в виде списка позиций (товаров), с указанием ячейки, в которой товар находится на складе (по запросу в
+2. Отображение в виде списка позиций (товаров) с указанием ячейки, в которой товар находится на складе (по запросу в
    пользовательском интерфейсе).
 
-3. Выбор определенного товара (позиции), для осуществления выдачи его аппаратной частью.
+3. Выбор определенного товара (позиции) для осуществления выдачи его аппаратной частью.
 4. Наличие удалённого склада для позиций, которые невозможно разместить на основном складе.
 5. Отображение в виде списка позиций (товаров), находящихся на удалённом складе.
 
+<a id="chapter-1"></a>
+
+## :hammer: Как начать
+
+1. Установить [Python 3](https://www.python.org/downloads/)
+2. Установить модуль requests: ```pip install requests```
+
+   [Инструкция по установке модулей при помощи PIP](https://pythonru.com/baza-znanij/ustanovka-pip-dlja-python-i-bazovye-komandy)
+
+3. Скачать данный репозиторий
+   * Вариант 1
+      1. Установить [Git](https://git-scm.com/download/win)
+      2. Клонировать репозиторий
+      ```bash
+      git clone https://github.com/W-A-L-L-3/electronic-storehouse
+      cd electronic-storehouse
+      ```
+   * Вариант 2 - [Скачать ZIP](https://github.com/W-A-L-L-3/electronic-storehouse/archive/main.zip)
+
+4. Запустить `./API/app.py`
+5. Запустить `./main.py`
+
+<a id="chapter-2"></a>
+
 ## Интерфейс приложения
 
 ### Главное окно
 
 #### До инициализации склада
 
-![main_window_1](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/img/main_window_1.jpg)
+![main_window_1](docs/img/main_window_1.jpg)
 
 **1** - Инициализация склада.
 
-При успешной инициализации появится всплывающие уведомление:
-
-![successful_initialization](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/img/successful%20initialization.jpg)
-
-Если произошла ошибка во время связи с API для инициализации:
+Уведомление об успешной инициализации склада:
 
-![receiving_error](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/img/receiving_error.jpg)
+![successful_initialization](docs/img/successful%20initialization.jpg)
 
 #### После инициализации склада
 
-![main_window_2](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/img/main_window_2.jpg)
+![main_window_2](docs/img/main_window_2.jpg)
 
 **2** - Добавление нескольких позиций из поставки на склад.
 
-**3** - Отображение в виде списка позиций (товаров), с указанием ячейки, в которой товар находится на складе.
+**3** - Отображение в виде списка позиций (товаров) с указанием ячейки, в которой товар находится на складе.
 
-**4** - Выбор определенного товара (позиции), для осуществления выдачи его аппаратной частью.
+**4** - Выбор определенного товара (позиции) для осуществления выдачи его аппаратной частью.
 
 **5** - Отображение в виде списка позиций (товаров), находящихся на удалённом складе.
 
-____
-
 ### Окно для добавления товаров на склад
 
-![adding_window_1](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/img/adding_window_1.jpg)
+![adding_window_1](docs/img/adding_window_1.jpg)
 
 **1** - Добавить строчку для ещё одного товара.
 
-**2** - Отправить товары на склад.
+**2** - Отправить все товары на склад.
 
 После двух нажатий кнопки **1**:
 
-![adding_window_2](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/img/adding_window_2.jpg)
+![adding_window_2](docs/img/adding_window_2.jpg)
 
-Корректный ввод позиций:
+_Корректный_ ввод позиций:
 
-![adding_window_3](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/img/adding_window_3.jpg)
+![adding_window_3](docs/img/adding_window_3.jpg)
 
-Некорректный ввод позиций:
++ Название - непустая строка
++ Размеры - 3 натуральных числа, разделённых "\*" (длина\*ширина\*высота)
++ Масса - натуральное число
 
-![adding_window_4](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/img/adding_window_4.jpg)
+_Некорректный_ ввод позиций:
 
-При успешной отправке товаров на склад появится всплывающие уведомление:
+![adding_window_4](docs/img/adding_window_4.jpg)
 
-![correct_adding](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/img/correct_adding.jpg)
+Уведомление об успешной отправке товаров на склад:
 
-Если значение в каком-либо из полей в поставке некорректно:
+![correct_adding](docs/img/correct_adding.jpg)
 
-![value_error](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/img/value_error.jpg)
+### Окно для отображения позиций (товаров), находящихся на складе
 
-____
+![info_window](docs/img/info_window.jpg)
 
-### Окно для отображения позиций (товаров), находящихся на складе
+### Окно для выбора определенного товара (позиции) для осуществления выдачи его аппаратной частью.
 
-![info_window](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/img/info_window.jpg)
+![taking_window](docs/img/taking_window.jpg)
 
-____
+При успешном выборе и выдаче товара появится всплывающие уведомление:
 
-### Окно для выбора определенного товара (позиции), для осуществления выдачи его аппаратной частью.
+![correct_taking](docs/img/correct_taking.jpg)
 
-![taking_window](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/img/taking_window.jpg)
+### Окно для отображения позиций (товаров), находящихся на удалённом складе
 
-При успешном выборе и выдаче товара появится всплывающие уведомление:
+![remote_info_window](docs/img/remote_info_window.jpg)
 
-![correct_taking](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/img/correct_taking.jpg)
+<a id="chapter-3"></a>
 
-Если товара с введённым названием нет на складе:
+## :heavy_exclamation_mark: Ошибки
 
-![taking_error](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/img/taking_error.jpg)
+### Ошибка получения параметров при инициализации
 
-____
+![error_of_getting_parameters](docs/img/receiving_error.jpg)
 
-### Окно для отображения позиций (товаров), находящихся на удалённом складе
+**Возможные причины:**
+
+1. Не запущено API (см. пункт 4 раздела [Как начать](#chapter-1)).
+2. Какая-либо ошибка связи с API.
+
+### Некорректное значение в каком-либо из полей в поставке
+
+![value_error](docs/img/value_error.jpg)
+
+### Товар не найден
+
+![taking_error](docs/img/taking_error.jpg)
+
+**Причина:**
+
+Товара с введённым названием нет на складе.
+
+<a id="chapter-4"></a>
+
+## Код
+
+### Папки
+
++ **API** - исходный код программной модели аппаратной части (взят
+  с [ppo_it_5_2021](https://dt.miet.ru/gitlab/dt_smartpark/ppo_it_5_2021))
++ **server** - серверная часть приложения (моделирование работы склада, обращение к API)
++ **gui** - клиентская часть приложения (графический интерфейс)
+
+### Используемые библиотеки
+
+* [tkinter](https://docs.python.org/3/library/tkinter.html) - графический интерфейс приложения
+* [json](https://docs.python.org/3/library/json.html) - работа с форматом json
+* [uuid](https://docs.python.org/3/library/uuid.html) - генерация случайного идентификатора товара
+* [pickle](https://docs.python.org/3/library/pickle.html) - хранение объекта модели склада в бинарном режиме
+* [requests](https://requests.readthedocs.io/en/master/) - составление HTTP-запросов
+
+<a id="chapter-5"></a>
+
+## :smile: Авторы
+<a href="https://github.com/Yu-Leo">
+    <img src="https://avatars3.githubusercontent.com/u/66430048?s=400&u=48f180775538c9967cc45bb4fc07ced723063a6e&v=4" width="50px">
+</a>
+<a href="https://github.com/kholevenkovav">
+    <img src="https://avatars3.githubusercontent.com/u/56455393?s=400&u=baa1b3fb667896e8cc43b0a4902ada8b143e4d7b&v=4" width="50px">
+</a>
+<a href="https://github.com/ASDF2357">
+    <img src="https://avatars3.githubusercontent.com/u/67108097?s=400&v=4" width="50px">
+</a> 
+
+<a id="chapter-6"></a>
+
+## :open_hands: Лицензия
+
+GNU General Public License v3.0.
 
-![remote_info_window](https://github.com/W-A-L-L-3/electronic-storehouse/blob/main/docs/img/remote_info_window.jpg)
+Полный текст в [LICENSE](LICENSE)

constants.py

@@ -1,11 +1,30 @@
 # File with constants
 
 STOREHOUSE_FILE_NAME = 'storehouse.pickle'
-GET_PARAMS_ADDRESS = 'http://127.0.0.1:5000/scheme'
+
+API_ADDRESS = 'http://127.0.0.1:5000'
+GET_PARAMS_ADDRESS = f'{API_ADDRESS}/scheme'
+
 MAX_ADDING_ITEMS = 30  # Maximum number of rows on one adding-window
 
 
 class AddingW:
     NAME_INDEX = 1
     SIZE_INDEX = 2
     MASS_INDEX = 3
+
+
+class Cell:
+    """Size of storehouse's cells"""
+    TYPE_1 = (1000, 1000, 1000)
+    TYPE_2 = (2000, 1000, 1000)
+    TYPE_3 = (2000, 2000, 1000)
+
+    REMOTE = "REMOTE"
+
+
+class ItemsSizes:
+    SMALL = "small"
+    MEDIUM = "medium"
+    BIG = "big"
+    LARGE = "large"

docs/img/adding_window_3.jpg

@@ -4,7 +4,7 @@
 OK = 0
 
 
-class ReceivingError(Exception):
+class GettingParamsError(Exception):
     pass
 
 

docs/img/info_window.jpg

@@ -32,6 +32,9 @@ def __init__(self):
                                take_func=self.open_giving_window,
                                remote_info_func=self.open_remote_info_window)
         self.info_window = None
+        self.adding_window = None
+        self.giving_window = None
+        self.remote_info_window = None
 
     def run(self):
         """Launching the app"""
@@ -40,7 +43,9 @@ def run(self):
 
     def open_info_window(self):
         table = server_operations.get_info()
-        self.info_window = InfoWindow(self, table, need_pos_column=True)
+        self.info_window = InfoWindow(self,
+                                      "Information about storehouse",
+                                      table, need_pos_column=True)
         self.info_window.draw()
 
     def open_adding_window(self):
@@ -55,8 +60,11 @@ def open_giving_window(self):
 
     def open_remote_info_window(self):
         table = server_operations.get_remote_info()
-        self.info_window = InfoWindow(self, table, need_pos_column=False)
-        self.info_window.draw()
+        self.remote_info_window = InfoWindow(self,
+                                             "Information about remote storehouse",
+                                             table, need_pos_column=False)
+        self.remote_info_window.draw()
+
 
 class ChildWindow(tk.Toplevel):
     def __init__(self, parent, title="", width=None, height=None,
@@ -81,9 +89,9 @@ def set_focus(self):
 class InfoWindow(ChildWindow):
     """Class of window for information about storehouse"""
 
-    def __init__(self, parent, table, need_pos_column):
+    def __init__(self, parent, title, table, need_pos_column):
         super().__init__(parent,
-                         title="Information about storehouse",
+                         title=title,
                          resizable=(False, False))
         self.__table = InfoTable(self, table, need_pos_column)
 

docs/img/remote_info_window.jpg

@@ -35,7 +35,8 @@ def show(self):
 class ExceptionMb(ErrorMb):
     """Messageboxes for my exceptions"""
 
-    def __get_msg(self, field):
+    @staticmethod
+    def __get_msg(field):
         first_part = text.entry_content_error["message"]
         if field == const.AddingW.NAME_INDEX:
             return first_part + " field 'Name'"

docs/social-preview.png

@@ -4,6 +4,7 @@
 
 font = (font_name, 12)
 
+
 class Btn:
     """Style-settings for buttons"""
     font = (font_name, 11)

docs/technical-documentation.pdf

@@ -61,8 +61,8 @@ def __call_init(self):
                       message=text.successful_init["message"]).show()
             self.__activate_btns()
         elif result == exceptions.RECEIVING_ERROR:
-            mb.ErrorMb(title=text.receiving_error["title"],
-                       message=text.receiving_error["message"]).show()
+            mb.ErrorMb(title=text.error_of_getting_parameters["title"],
+                       message=text.error_of_getting_parameters["message"]).show()
 
     def __activate_btns(self):
         """Activate buttons for interacting with storehouse"""
@@ -323,7 +323,7 @@ def formatted_size(self):
         """
         value = self.__get_size()
         if self.__check_size(value):
-            t = value.split("*")
+            t = map(int, value.split("*"))
             return tuple(t)
         else:
             raise exc.EntryContentError(const.AddingW.SIZE_INDEX)