Metadata-Version: 2.1
Name: grupob_trace_logger
Version: 0.1.2
Summary: Uma biblioteca de logger que envia mensagens para o Discord
Home-page: https://github.com/juniorppp/trace_logger
Author: Gelson Júnior
Author-email: gelson.junior@grupobachega.com.br
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENCE
Requires-Dist: requests

Aqui está uma versão mais profissional e aprimorada do seu `README.md`:

---

# GrupoB Trace Logger

GrupoB Trace Logger é uma biblioteca Python simples e eficiente para registrar exceções e enviar mensagens diretamente para um canal do Discord através de um Webhook. Ela foi projetada para ajudar no monitoramento e acompanhamento de erros ou eventos importantes em aplicações, de maneira integrada com o Discord.

## Instalação

Você pode instalar a biblioteca utilizando o `pip`:

```bash
pip install grupob_trace_logger
```

## Como Usar

Abaixo estão exemplos de uso da biblioteca para registrar exceções e enviar notificações para um canal do Discord.

### Uso Básico

No exemplo a seguir, criamos uma instância da classe `Log` e registramos uma exceção diretamente:

```python
from grupob_trace_logger.log import Log

try:
    marionette = Marionette()  # Exemplo de código que pode gerar uma exceção
except Exception as ex:
    log = Log(
        webhook_url="https://discord.com/api/webhooks/##################/##############-####_################-########################################",
        responsavel="Gelson Júnior",  # Nome do responsável pelo código
        nome_robo="Calculadora"  # Nome do robô ou serviço que está executando
    )
    log.register(ex)  # Registra a exceção no Discord
```

### Uso com Parâmetros Dinâmicos

Você também pode passar os parâmetros diretamente no método `register`. Caso os valores sejam fornecidos tanto no construtor quanto no método `register`, os valores do método `register` serão priorizados:

```python
from grupob_trace_logger.log import Log

try:
    marionette = Marionette()  # Exemplo de código que pode gerar uma exceção
except Exception as ex:
    log = Log(
        webhook_url="https://discord.com/api/webhooks/##################/##############-####_################-########################################"
    )
    log.register(
        ex,
        {
            "nome_robo": "Projeto Z",  # Nome personalizado do robô ou serviço
            "responsavel": "Gelson Júnior"  # Nome do responsável pelo código
        }
    )
```

### Parâmetros

- **webhook_url** (obrigatório): A URL do webhook do Discord para onde as mensagens de log serão enviadas.
- **responsavel** (opcional): Nome da pessoa responsável pelo código ou robô.
- **nome_robo** (opcional): Nome do robô, serviço ou aplicação que está executando.

## Exemplo de Mensagem no Discord

Ao registrar uma exceção, a mensagem enviada para o canal do Discord será formatada com detalhes sobre o erro, o nome do robô (ou serviço) e o responsável pela execução.

Exemplo de mensagem no Discord:

```
[Erro] O robô Calculadora encontrou um problema:
Exception: divisão por zero
Responsável: Gelson Júnior
```

## Contribuindo

Contribuições são sempre bem-vindas! Se você encontrar problemas ou tiver sugestões de melhorias, fique à vontade para abrir uma issue ou enviar um pull request.

## Licença

Este projeto está licenciado sob a licença MIT. Consulte o arquivo [LICENSE](LICENSE) para mais detalhes.

---

Grupo Bachega
