pytestreport-md


Namepytestreport-md JSON
Version 0.1.5 PyPI version JSON
download
home_pageNone
SummaryUma biblioteca para gerar relatórios de teste com emojis
upload_time2025-01-02 01:52:34
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords pytest report emojis
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # pytest-report

```markdown
# pytestreport-md

[![PyPI Version](https://img.shields.io/pypi/v/pytestreport-md.svg)](https://pypi.org/project/pytestreport-md/)
[![License](https://img.shields.io/pypi/l/pytestreport-md.svg)](https://opensource.org/licenses/MIT)

Uma biblioteca para gerar relatórios de testes com emojis de maneira simples e estilizada!

## 🚀 Instalação

Você pode instalar o `pytestreport-md` diretamente do PyPI usando o pip:

# bash
pip install pytestreport-md
```

## 📄 Descrição

O `pytestreport-md` é uma biblioteca leve que facilita a geração de relatórios de testes em formato Markdown. Ele transforma os resultados de testes em relatórios estilizados, incluindo emojis para indicar o status de cada teste (✅ para aprovados e ❌ para falhos).

## 🛠️ Como Usar

Aqui está um exemplo básico de uso:

```python
from pytestreport.reporter import generate_report_pytest

test_results = """
TestExample1 - PASSED | TestExample2 - FAILED | TestExample3 - PASSED
"""

generate_report_pytest(prefix="Name project", test_results=test_results, output_path="report.md")
```

### Resultado

Um arquivo `report.md` será gerado com um relatório detalhado:

```
## Test Report - `Name project`

--------------------------------------------------
### 📝 Test results

**Total Tests**: 3  
**Passed**: 2  
**Failed**: 1  

### Passed Tests ✅
- TestExample1
- TestExample3

### Failed Tests ❌
- TestExample2

--------------------------------------------------
### 📊 Test Summary

- **Passed Tests**: 2 ✅
- **Failed Tests**: 1 ❌

---
_Report styled with ❤️ for `Name project` on 01-Jan-2025 at 10:00:00_
```

## ⚙️ Configuração Adicional

Se necessário, você pode personalizar o comportamento da função `generate_report_pytest`:

- **`prefix`**: Colocar o nome do projeto que você está utilizando no relatório de teste.
- **`test_results`**: Resultados dos testes no formato `<nome do teste> - <status>`, separados por `|`.
- **`output_path`**: Caminho para salvar o relatório Markdown (por padrão, `report.md` será criado no diretório atual).

## 🧪 Testes

Para rodar os testes do projeto:

```bash
pytest
```

Certifique-se de estar no ambiente virtual configurado e que as dependências de desenvolvimento estejam instaladas.

## 📝 Licença

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

## 📬 Contribuições

Contribuições são bem-vindas! Sinta-se à vontade para abrir issues ou enviar pull requests no [repositório do projeto](https://github.com/Hedriss10/pytest-report).

## 📚 Recursos

- **Repositório**: [GitHub](https://github.com/Hedriss10/pytest-report)
- **PyPI**: [pytestreport-md](https://pypi.org/project/pytestreport-md/)

---

Feito com ❤️ por [Hedris Pereira](https://github.com/Hedriss10)

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pytestreport-md",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "pytest, report, emojis",
    "author": null,
    "author_email": "Hedris Pereira <hedrisgts@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/f3/0c/f55222e3d8e69b3e91c4b1264058d307ea1114712eaef35c11a3a4e6c1f5/pytestreport_md-0.1.5.tar.gz",
    "platform": null,
    "description": "# pytest-report\n\n```markdown\n# pytestreport-md\n\n[![PyPI Version](https://img.shields.io/pypi/v/pytestreport-md.svg)](https://pypi.org/project/pytestreport-md/)\n[![License](https://img.shields.io/pypi/l/pytestreport-md.svg)](https://opensource.org/licenses/MIT)\n\nUma biblioteca para gerar relat\u00f3rios de testes com emojis de maneira simples e estilizada!\n\n## \ud83d\ude80 Instala\u00e7\u00e3o\n\nVoc\u00ea pode instalar o `pytestreport-md` diretamente do PyPI usando o pip:\n\n# bash\npip install pytestreport-md\n```\n\n## \ud83d\udcc4 Descri\u00e7\u00e3o\n\nO `pytestreport-md` \u00e9 uma biblioteca leve que facilita a gera\u00e7\u00e3o de relat\u00f3rios de testes em formato Markdown. Ele transforma os resultados de testes em relat\u00f3rios estilizados, incluindo emojis para indicar o status de cada teste (\u2705 para aprovados e \u274c para falhos).\n\n## \ud83d\udee0\ufe0f Como Usar\n\nAqui est\u00e1 um exemplo b\u00e1sico de uso:\n\n```python\nfrom pytestreport.reporter import generate_report_pytest\n\ntest_results = \"\"\"\nTestExample1 - PASSED | TestExample2 - FAILED | TestExample3 - PASSED\n\"\"\"\n\ngenerate_report_pytest(prefix=\"Name project\", test_results=test_results, output_path=\"report.md\")\n```\n\n### Resultado\n\nUm arquivo `report.md` ser\u00e1 gerado com um relat\u00f3rio detalhado:\n\n```\n## Test Report - `Name project`\n\n--------------------------------------------------\n### \ud83d\udcdd Test results\n\n**Total Tests**: 3  \n**Passed**: 2  \n**Failed**: 1  \n\n### Passed Tests \u2705\n- TestExample1\n- TestExample3\n\n### Failed Tests \u274c\n- TestExample2\n\n--------------------------------------------------\n### \ud83d\udcca Test Summary\n\n- **Passed Tests**: 2 \u2705\n- **Failed Tests**: 1 \u274c\n\n---\n_Report styled with \u2764\ufe0f for `Name project` on 01-Jan-2025 at 10:00:00_\n```\n\n## \u2699\ufe0f Configura\u00e7\u00e3o Adicional\n\nSe necess\u00e1rio, voc\u00ea pode personalizar o comportamento da fun\u00e7\u00e3o `generate_report_pytest`:\n\n- **`prefix`**: Colocar o nome do projeto que voc\u00ea est\u00e1 utilizando no relat\u00f3rio de teste.\n- **`test_results`**: Resultados dos testes no formato `<nome do teste> - <status>`, separados por `|`.\n- **`output_path`**: Caminho para salvar o relat\u00f3rio Markdown (por padr\u00e3o, `report.md` ser\u00e1 criado no diret\u00f3rio atual).\n\n## \ud83e\uddea Testes\n\nPara rodar os testes do projeto:\n\n```bash\npytest\n```\n\nCertifique-se de estar no ambiente virtual configurado e que as depend\u00eancias de desenvolvimento estejam instaladas.\n\n## \ud83d\udcdd Licen\u00e7a\n\nEste projeto est\u00e1 licenciado sob os termos da licen\u00e7a MIT. Veja o arquivo [LICENSE](LICENSE) para mais detalhes.\n\n## \ud83d\udcec Contribui\u00e7\u00f5es\n\nContribui\u00e7\u00f5es s\u00e3o bem-vindas! Sinta-se \u00e0 vontade para abrir issues ou enviar pull requests no [reposit\u00f3rio do projeto](https://github.com/Hedriss10/pytest-report).\n\n## \ud83d\udcda Recursos\n\n- **Reposit\u00f3rio**: [GitHub](https://github.com/Hedriss10/pytest-report)\n- **PyPI**: [pytestreport-md](https://pypi.org/project/pytestreport-md/)\n\n---\n\nFeito com \u2764\ufe0f por [Hedris Pereira](https://github.com/Hedriss10)\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Uma biblioteca para gerar relat\u00f3rios de teste com emojis",
    "version": "0.1.5",
    "project_urls": {
        "Repository": "https://github.com/Hedriss10/pytest-report/tree/main"
    },
    "split_keywords": [
        "pytest",
        " report",
        " emojis"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "38dea32b72c6081ee2509cd69184947535d877af055eb7536a6f3d3c519b5f01",
                "md5": "2d1a832a39b48f71cf5b18f95c4b47b3",
                "sha256": "c1c13ed9a7e4961a63cebc6456f6d9eba9a207894fdd131c25795c7a85be3cd8"
            },
            "downloads": -1,
            "filename": "pytestreport_md-0.1.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2d1a832a39b48f71cf5b18f95c4b47b3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4388,
            "upload_time": "2025-01-02T01:52:31",
            "upload_time_iso_8601": "2025-01-02T01:52:31.735447Z",
            "url": "https://files.pythonhosted.org/packages/38/de/a32b72c6081ee2509cd69184947535d877af055eb7536a6f3d3c519b5f01/pytestreport_md-0.1.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f30cf55222e3d8e69b3e91c4b1264058d307ea1114712eaef35c11a3a4e6c1f5",
                "md5": "fda40a411987b7299c4fac623b1127af",
                "sha256": "0fff7d9af2dc4f2b0461b84c83182bc2a69371ebbe2ac569eaea8b21cf87bee9"
            },
            "downloads": -1,
            "filename": "pytestreport_md-0.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "fda40a411987b7299c4fac623b1127af",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4159,
            "upload_time": "2025-01-02T01:52:34",
            "upload_time_iso_8601": "2025-01-02T01:52:34.101411Z",
            "url": "https://files.pythonhosted.org/packages/f3/0c/f55222e3d8e69b3e91c4b1264058d307ea1114712eaef35c11a3a4e6c1f5/pytestreport_md-0.1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-02 01:52:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Hedriss10",
    "github_project": "pytest-report",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pytestreport-md"
}
None
Elapsed time: 0.37965s