Развертывание на локальной машине

1. Установить pipenv sudo apt update, apt install pipenv
2. Создать виртуальное окружение и установить зависимости: pipenv sync
3. Запустить виртуальное окружение: pipenv shell
4. Миграции, Создание локальной БД flask db upgrade (Доп команды: flask db init, flask db migrate -m "new")
5. Коллекция запросов Postman находится в дирректории PosnmanCollection

Автотесты

1. Запуск: pytest -v tests

Реализовано ТЗ

Основные возможности:

• Регистрация пользователя.

• Авторизация пользователя.

• Создание заметки. Каждая заметка привязывается к конкретному пользователю. Без регистрации нельзя создавать заметки.

• Просмотр своих заметок.

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

• Редактирование собственных заметок. Изменение текста заметки и ее статуса(публичная/частная).

• Удаление собственных заметок.

Дополнительные возможности:

• Создание списка категорий
• Добавление категорий заметке.
• Получение заметок по определенным категориям.

Продвинутая фильтрация

• Реализован обработчик для получения всех заметок пользователя
• Поиск всех заметок авторизованного пользователя, у которых есть указанный тег
• Поиск всех публичных заметок, пользователя из query параметров

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

• Добавлены все обработчики в документацию
• Все функции обернуты в декораторы @marshal_with и @use_kwargs
• Перенесены все настройки swagger init.py → config.py

Полезное

1. Более наглядные автотесты pipenv install coverage``coverage run -m pytest ./tests/``coverage html
2. Документация pipenv install apispec,pipenv install flask-apispec