Skip to content
Snippets Groups Projects
Commit 7d2fb60a authored by Artur Sabirov's avatar Artur Sabirov Committed by Artur Sabirov
Browse files

chore: update README.md

parent e23222ac
No related branches found
No related tags found
1 merge request!429chore: update README.md
Pipeline #39479 passed
......@@ -13,6 +13,7 @@
* [Линтинг скриптов Python](#линтинг-скриптов-python)
* [Форматирование скриптов Python](#форматирование-скриптов-python)
* [Активация виртуального окружения Pipenv](#активация-виртуального-окружения-pipenv)
* [Добавление зависимостей](#добавление-зависимостей)
* [Запуск документации Picodata в Docker](#запуск-документации-picodata-в-docker)
# Тестирование документации Picodata
......@@ -84,14 +85,12 @@ python -m http.server -d site --bind 127.0.0.1
pipenv run lint
```
Скрипт `ci/validation.py` будет последовательно проверен с помощью следующих модулей:
Хуки из папки `hooks` будет последовательно проверены с помощью следующих модулей:
* [`flake8`](https://github.com/pycqa/flake8/)
* [`black`](https://github.com/psf/black)
* [`mypy`](https://github.com/python/mypy)
Далее, скрипт `ci/validation.py` будет запущен
## Форматирование скриптов Python
Введите команду:
......@@ -100,7 +99,7 @@ pipenv run lint
pipenv run fmt
```
Форматирование скрипта `ci/validation.py` будет скорректировано форматтером `black`
Форматирование хуков из папки `hooks` будет скорректировано форматтером `black`
## Активация виртуального окружения Pipenv
......@@ -114,6 +113,18 @@ pipenv shell
Для выхода из виртуального окружения Pipenv введите `exit` или нажмите `Ctrl + D`
## Добавление зависимостей
Введите команду:
``` shell
pipenv update <package>
```
где `<package>` — название добавляемого модуля
Команда добавляет модуль в [Pipfile](Pipfile) и [Pipfile.lock](Pipfile.lock), затем устанавливает его в виртуальное окружение Pipenv
# Запуск документации Picodata в Docker
С помощью [Dockerfile](docker/static/Dockerfile) можно собрать сайт документации Picodata внутри образа [Docker](https://docs.docker.com/), затем запустить образ в контейнере
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment