Morelia Tk - мессенджер (клиент) для платформы Windows

тут скриншот

В репозитории 2 бранча

master - Основная и стабильная ветка.

develop - Ветка для добавления нового функционала.

В разработке применяется

Python 3.8 - язык программирования

PyQt5 как основной фронтенд фреймворк

Установка

Установить Python версии 3.8.

Загрузить и установить последнюю версию git.

Если нужен GUI, установить GitHub Desktop.

Настроить Git или GitHub Desktop введя свои username и email от аккаунта созданного на github.

Загрузить и установить Qt Designer

Форк репозитория Morelia Tk

Если ты не включен в команду на GitHub'е проекта, то тебе необходимо сначала форкнуть к себе репозиторий Morelia Tk перейдя по ссылке.

Клонирование репозитория на локальный компьютер

Клонировать репозиторий к себе на локальный компьютер используя командную строку и git

git clone https://github.com/{username}/morelia_client_tk.git
cd morelia_client_tk

Переключаемся на ветку develop

git checkout develop

Синхронизируем свой форк с оригинальным репозиторием upstream Morelia Tk

git remote add upstream https://github.com/MoreliaTalk/morelia_client_tk.git

Проверяем появились ли репозиторий upstream в списке удалённых репозиториев

git remote -v
> origin    https://github.com/{username}/morelia_client_tk.git (fetch)
> origin    https://github.com/{username}/morelia_client_tk.git (push)
> upstream  https://github.com/MoreliaTalk/morelia_client_tk.git (fetch)
> upstream  https://github.com/MoreliaTalk/morelia_client_tk.git (push)

При использовании GitHub выбрать в меню File пункт Clone repository... далее следовать инструкциям

Настройка виртуального окружения Pipenv

Для работы с проектом необходима установка библиотек которые он использует, т.н. рабочее окружение, для этого используется утилита Pipenv

Если не установлен pipenv, выполнить

python -m pip install pipenv

Создать виртуальное окружение в директории с проектом

pipenv shell

Установить все требуемые библиотеки из Pipfile

pipenv install --ignore-pipfile

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

Для запуска используйте команду

python ./messenger.py

Создание пулл-реквеста для внесенния изменений в develop-ветку Morelia Tk

Получение последних изменнений из develop-ветки Morelia Tk

git pull upstream develop

Отправка изменений в develop-ветку своего форка

git push

Для создания пулл-реквеста, необходимо перейти на GitHub, выбрать свой форк и в правом меню нажать на New pull request, после чего выбрать бранч из которого будет производится перенос изменений в develop-ветку Morelia Tk и нажать Create pull request.

Требования к стилю кода

Перед началом работы рекомендуется прочитать PEP 8 - руководство по написанию кода на Python. Обязательно использовать линтер (flake8, pylint или подобный).

Контакты

Telegram - группа где обсуждаются насущные вопросы.

Trello - kanban-доска для проекта.