## 📜 Overview: Обзор шаблона

### О шаблоне
[`projectTemplate`](https://github.com/maxlansky1/projectTemplate) — это универсальный шаблон для создания Python-проектов, разработанный с учётом современных практик разработки, документирования и автоматизации.

Этот шаблон предоставляет всё необходимое для старта нового проекта:

- 🐳 **Поддержка Docker и docker-compose** — для контейнеризации и удобства развертывания.
- 📚 **Настроенная Sphinx-документация с возможностью редактирования на Markdown** — для лёгкого создания и поддержания документации.
- 🔄 **Инструменты для автоматической генерации диаграмм UML** — для визуализации структуры вашего проекта.
- 🧑‍💻 **Система проверки кода через Ruff и форматтер Black** — для обеспечения качества и читаемости кода.
- 🚀 **CI/CD пайплайны для автоматического тестирования и деплоя документации** — для обеспечения автоматизации тестов и развертывания.
- ⚡ **Удобный Makefile для быстрого запуска команд** — для удобства в работе с проектом.

```{eval-rst}
.. uml:: ../../projectTemplate/diagrams/project_structure.puml
   :scale: 10%
   :align: center
```
### Быстрый старт
1. Установите Python на свой ПК
```{admonition} Используйте
:class:tip
[Подробный гайд по установке Python](https://realpython.com/installing-python/)
```
2. Скачайте VS Code [с официального сайта](https://code.visualstudio.com/)
```{admonition} Прочитайте
:class:tip
[Подробный гайд по началу работы с VS Code](https://habr.com/ru/articles/490754/)
```

3. Обновите настройки VS Code
Settings - Open Settings JSON

Вставьте туда следующий код, чтобы настроить переменные окружения
```json
{
  // Настройки переменных окружения для Windows
  "terminal.integrated.env.windows": {
    "PYTHONPATH": "${workspaceFolder}"
  },

  // Настройки переменных окружения для Linux
  "terminal.integrated.env.linux": {
    "PYTHONPATH": "${workspaceFolder}"
  },

  // Настройки переменных окружения для macOS
  "terminal.integrated.env.osx": {
    "PYTHONPATH": "${workspaceFolder}"
  }
}
```
```{tip}
Можно быстро зайти в настройки при помощи `Ctrl+,`. Не забудьте сменить раскладку клавиатуры на английскую
```

4. Скачайте и настройте Git 
```{admonition} Прочитайте
:class: tip
[Подробная инструкция по установке и настройке Git](https://habr.com/ru/articles/541258/)
```

5. Создайте папку вашего проекта и добавьте ее в VS Code Workspace

6. Откроте терминал, инициализируйте Git в папке вашего проекта
```{hint}
На верхней панели можно нажать Terminal - New Terminal - выбрать нужную папку.
```
```bash
git init 
```

Теперь Git отслеживает версии вашего проекта. 

7. Создайте виртуальное окружение
Не выходя из терминала
````{admonition} Пример для папки с именем qwerty123
:class: dropdown
```bash
python -m venv venv
```
````

8. Активируйте виртуальное окружение
````{admonition}
:class: dropdown
Для Windows:
```bash
.\venv\Scripts\activate
```

Для macOS/Linux:
```bash
source venv/bin/activate
```
````

````{note}
После активации вы должны увидеть в терминале значок `(venv)` слева от папки вашего проекта
```text
(venv) PS C:\user\blablabla\qwerty123
```
````

9. Установите `copier`, используя следующую команду терминала
```bash
pip install copier
```
10. Скопируйте шаблон с GitHub
```bash
copier copy gh:/maxlansky1/projectTemplate path/to/qwerty123
```

````{attention}
`copier copy` - скопировать шаблон
`gh:/maxlansky1/projectTemplate` - путь к шаблону на GitHub
`path/to/qwerty123` - путь к папке вашего локального проекта
```{note}
1. Если кликнуть правой кнопкой мышки на папку проекта, можно скопировать полный путь
2. Правый клик мышки в окне терминала вставит текст из буфера обмена
```
````

Введите ответы на вопросы `copier` в терминале или просто нажмите Enter для согласия со стандартными ответами

11. Зарегистрируйтесь на GitHub, создайте новый репозиторий и сделайте пуш
```{note}
При создании нового репозитория GitHub подскажет, какие команды использовать
```

12. Периодически обновляйте шаблон

```bash
copier update
```