diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6cc3f8f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,12 @@ +## Что нужно для запуска + + 1. python3.11. Установка описана [тут](https://www.python.org/downloads/) + + 2. Завсимости, описанные в setup.py, requirements.dev.txt + + + ## Codestyle + + - Black. Как пользоваться описано [тут](https://black.readthedocs.io/en/stable/) + + - Также применяем [isort](https://pycqa.github.io/isort/) diff --git a/README.md b/README.md index 216b0f0..863dfd7 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,13 @@ # logging-lib Библиотека для логирования сервисов Твой ФФ! +## Функционал +Форматирование логов в общий для всех бэкендов JSON-формат + [![pypi](https://img.shields.io/pypi/dm/logging-profcomff?label=PIP%20INSTALLS&style=for-the-badge)](https://pypi.org/project/logging-profcomff) [![tg](https://img.shields.io/badge/telegram-Viribus%20unitis-brightgreen?style=for-the-badge&logo=telegram)](https://t.me/+eIMtCymYDepmN2Ey) -## Как подключить +## Сценарий использования 1. В requirements.txt добавьте logging-profcomff 2. Скопируйте из /gunicorn_logging_examples обе конфигурации 3. Вставьте их в корень проекта @@ -13,3 +16,8 @@ 6. Пропишите туда "--log-config $CONF_FILE" 7. В Actions в запуск добавьте(прод) --build-args: docker build --build-arg CONF_FILE=logging_prod.conf 8. В Actions в запуск добавьте(тест) --build-args: docker build --build-arg CONF_FILE=logging_test.conf + +## Contributing + - Основная [информация](https://github.com/profcomff/.github/wiki/%255Bdev%255D-Backend-%25D1%2580%25D0%25B0%25D0%25B7%25D1%2580%25D0%25B0%25D0%25B1%25D0%25BE%25D1%2582%25D0%25BA%25D0%25B0) по разработке наших приложений + + - [Ссылка](https://github.com/profcomff/logging-lib/blob/main/CONTRIBUTING.md) на страницу с информацией по разработке logging-lib