Metadata-Version: 2.1
Name: pyloggering
Version: 0.9.2
Summary: Module for sumple logging
Home-page: https://github.com/K1AYPVA/logger
Author: K1ayPVA
Author-email: kegor6137@gmail.com
Project-URL: Documentation, https://github.com/K1AYPVA/logger/tree/main
Keywords: log logs python
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE

## Документация к модулю логирования
Модуль logger предоставляет функции для логирования действий в Python. Он позволяет создавать файл логов и записывать в него сообщения различных уровней, а также выводить эти сообщения в консоль.


![PyPI - Version](https://img.shields.io/pypi/v/dacite?style=flat&label=dacite)
![PyPI - Version](https://img.shields.io/pypi/v/colorama?style=flat&label=colorama)


## Подключение
Прежде чем использовать модуль, убедитесь, что у вас установлен Python версии 3.x и выше.
```python
import pyloggering
```
## Функции модуля
# 1. Создание файла для логирования:
Создает файл логов с указанным именем. Если файл уже существует, он будет дописыватся
Убедитесь, что у вас имеются права на запись в директорию, где вы хотите создать файл логов.
 ```python
pyloggering.create_file(name, location, type, writing)
```
Параметры:

name -> Имя файла для логирования


location -> путь до директории файла логов


type -> тип выходного файла. txt либо log


writing - Будут ли логи записыватся в файл. True - да, False - нет

# Пример:
```python
import pyloggering

pyloggering.create_file("log", "./assets", ".log", True)
```
Output:


![image](https://github.com/user-attachments/assets/46ca7094-5031-45cf-b1d9-e2c61175dabd)



## 2. Уровень логирования INFO и его функция:

Выводит в консоль лог с уровнем INFO и записывает его в файл.


```python
pyloggering.info(text)
```
Параметры:


text -> Текст который будет выведен в консоль и записан в файл





Пример:
```python
import pyloggering

pyloggering.create_file("log", "./assets", ".log", True)
pyloggering.info("Test, check file and console")
```
Output:


![image](https://github.com/user-attachments/assets/8b97093e-06a2-4918-bd97-0e18875a2494)


## 3. Уровень логирования WARN и его функция:


Выводит в консоль лог с уровнем warning и записывает его в файл.

```python
pyloggering.warning(text)
```
Параметры:


text -> Текст который будет выведен в консоль и записан в файл

Пример:


```python
import pyloggering

pyloggering.create_file("log", "./assets", ".log", True)
pyloggering.warning("Test, check file and console")
```
Output:


![image](https://github.com/user-attachments/assets/812c10a8-4e28-43c9-99c4-e02fce24c9d5)


## 4. Уровень логирования SUCCESS и его функция:
Выводит в консоль лог с уровнем success и записывает его в файл.

```python
pyloggering.success(text)
```
Параметры:


text -> Текст который будет выведен в консоль и записан в файл

Пример:


```python
import pyloggering

pyloggering.create_file("log", "./assets", ".log", True)
pyloggering.success("Test, check file and console")
```
Output:

![image](https://github.com/user-attachments/assets/0e103fe1-865b-4427-aad1-df8b5d3446a8)


## 5. Уровень логирования CRIT и его функция:
Выводит в консоль лог с уровнем critical и записывает его в файл.

```python
pyloggering.critical(text)
```
Параметры:


text -> Текст который будет выведен в консоль и записан в файл

Пример:


```python
import pyloggering
pyloggering.create_file("log", "./assets", ".log", True)
pyloggering.critical("Test, check file and console")
```
Output:

![image](https://github.com/user-attachments/assets/4ea60f10-8b9f-4356-bbc3-fa5a2d00a41d)



## 6. Уровень логирования DEBUG и его функция:
Выводит в консоль лог с уровнем debug и записывает его в файл.


```python
pyloggering.debug(text)
```
Параметры:


text -> Текст который будет выведен в консоль и записан в файл

Пример:


```python
import pyloggering

pyloggering.create_file("log", "./assets", ".log", True)
pyloggering.debug("Test, check file and console")
```
Output:

![image](https://github.com/user-attachments/assets/04b52fc7-f25e-4683-9ed7-636aa2dca637)
