diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d53edd..5a1ae15 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to Transcriptase +# Contributing to Testrail API Reporter We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: - Reporting a bug @@ -34,7 +34,7 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue] - A quick summary and/or background - Steps to reproduce - Be specific! - - Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing + - Give sample code if you can. [Stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing - What you expected would happen - What actually happens - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) diff --git a/LICENSE b/LICENSE index 0bec452..6ad26ee 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2023 Ilya Vereshchagin +Copyright (c) 2024 Ilya Vereshchagin Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/__init__.py b/__init__.py index 9432086..449b750 100644 --- a/__init__.py +++ b/__init__.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """ This module is used to import all the classes and functions from the package """ # Engines diff --git a/testrail_api_reporter/__init__.py b/testrail_api_reporter/__init__.py index 8444d49..b03abcd 100644 --- a/testrail_api_reporter/__init__.py +++ b/testrail_api_reporter/__init__.py @@ -1,4 +1,5 @@ -"""testrail_api_reporter package""" +# -*- coding: utf-8 -*- +""" testrail_api_reporter package """ # Engines from .engines.at_coverage_reporter import ATCoverageReporter diff --git a/testrail_api_reporter/engines/__init__.py b/testrail_api_reporter/engines/__init__.py index f249908..05baff2 100644 --- a/testrail_api_reporter/engines/__init__.py +++ b/testrail_api_reporter/engines/__init__.py @@ -1,4 +1,5 @@ -"""Engines package""" +# -*- coding: utf-8 -*- +""" Engines for testrail_api_reporter package """ from .at_coverage_reporter import ATCoverageReporter from .case_backup import TCBackup diff --git a/testrail_api_reporter/engines/at_coverage_reporter.py b/testrail_api_reporter/engines/at_coverage_reporter.py index 5622528..5dcd64c 100644 --- a/testrail_api_reporter/engines/at_coverage_reporter.py +++ b/testrail_api_reporter/engines/at_coverage_reporter.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """ Engine to generate obtain TestRail data and prepare reports """ from requests.exceptions import ReadTimeout diff --git a/testrail_api_reporter/engines/case_backup.py b/testrail_api_reporter/engines/case_backup.py index d4d97c6..d56283e 100644 --- a/testrail_api_reporter/engines/case_backup.py +++ b/testrail_api_reporter/engines/case_backup.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """ TestRails backup module """ import os diff --git a/testrail_api_reporter/engines/plotly_reporter.py b/testrail_api_reporter/engines/plotly_reporter.py index 052edc1..ae89d70 100644 --- a/testrail_api_reporter/engines/plotly_reporter.py +++ b/testrail_api_reporter/engines/plotly_reporter.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """ Confluence sender module """ import plotly diff --git a/testrail_api_reporter/engines/results_reporter.py b/testrail_api_reporter/engines/results_reporter.py index 88aa096..2373fcd 100644 --- a/testrail_api_reporter/engines/results_reporter.py +++ b/testrail_api_reporter/engines/results_reporter.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """ Module for reporting results to TestRails from xml report results, obtained by pytest """ import datetime diff --git a/testrail_api_reporter/publishers/__init__.py b/testrail_api_reporter/publishers/__init__.py index 05d0bdd..e50f10a 100644 --- a/testrail_api_reporter/publishers/__init__.py +++ b/testrail_api_reporter/publishers/__init__.py @@ -1,4 +1,5 @@ -"""Publishers package""" +# -*- coding: utf-8 -*- +""" Publishers for testrail_api_reporter package """ from .confluence_sender import ConfluenceSender from .email_sender import EmailSender diff --git a/testrail_api_reporter/publishers/confluence_sender.py b/testrail_api_reporter/publishers/confluence_sender.py index 383aa6e..647616f 100644 --- a/testrail_api_reporter/publishers/confluence_sender.py +++ b/testrail_api_reporter/publishers/confluence_sender.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """ Confluence sender module """ from atlassian import Confluence diff --git a/testrail_api_reporter/publishers/email_sender.py b/testrail_api_reporter/publishers/email_sender.py index 8568598..f83adc1 100644 --- a/testrail_api_reporter/publishers/email_sender.py +++ b/testrail_api_reporter/publishers/email_sender.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """ Email sender module """ import base64 diff --git a/testrail_api_reporter/publishers/gdrive_uploader.py b/testrail_api_reporter/publishers/gdrive_uploader.py index b73c15c..85de09d 100644 --- a/testrail_api_reporter/publishers/gdrive_uploader.py +++ b/testrail_api_reporter/publishers/gdrive_uploader.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """ Google Drive uploader module """ import json diff --git a/testrail_api_reporter/publishers/slack_sender.py b/testrail_api_reporter/publishers/slack_sender.py index 46b3e9b..8fb0d06 100644 --- a/testrail_api_reporter/publishers/slack_sender.py +++ b/testrail_api_reporter/publishers/slack_sender.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """ Slack sender module """ import json diff --git a/testrail_api_reporter/utils/__init__.py b/testrail_api_reporter/utils/__init__.py index 1fc0899..0c23420 100644 --- a/testrail_api_reporter/utils/__init__.py +++ b/testrail_api_reporter/utils/__init__.py @@ -1,4 +1,5 @@ -"""Utils for testrail_api_reporter package""" +# -*- coding: utf-8 -*- +""" Utils for testrail_api_reporter package """ from .logger_config import setup_logger from .reporter_utils import upload_image, delete_file, zip_file diff --git a/testrail_api_reporter/utils/case_stat.py b/testrail_api_reporter/utils/case_stat.py index 455c041..fc1daf9 100644 --- a/testrail_api_reporter/utils/case_stat.py +++ b/testrail_api_reporter/utils/case_stat.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """ CaseStat class """ diff --git a/testrail_api_reporter/utils/csv_parser.py b/testrail_api_reporter/utils/csv_parser.py index d1710d4..955543a 100644 --- a/testrail_api_reporter/utils/csv_parser.py +++ b/testrail_api_reporter/utils/csv_parser.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """ CSV parser for TestRail API Reporter """ import csv diff --git a/testrail_api_reporter/utils/logger_config.py b/testrail_api_reporter/utils/logger_config.py index a926986..6933bfc 100644 --- a/testrail_api_reporter/utils/logger_config.py +++ b/testrail_api_reporter/utils/logger_config.py @@ -1,7 +1,5 @@ # -*- coding: utf-8 -*- -""" -Logger configuration -""" +"""Logger configuration""" import logging import sys diff --git a/testrail_api_reporter/utils/reporter_utils.py b/testrail_api_reporter/utils/reporter_utils.py index 836d2ec..322c6a4 100644 --- a/testrail_api_reporter/utils/reporter_utils.py +++ b/testrail_api_reporter/utils/reporter_utils.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """ This module contains service functions for reporter """ import os diff --git a/tests/conftest.py b/tests/conftest.py index 0814e80..904133c 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """Conftest for testsuite""" from os import path, remove diff --git a/tests/utils/test_reporter_utils_cqptions.py b/tests/utils/test_reporter_utils_cqptions.py index db07aea..fd03d9b 100644 --- a/tests/utils/test_reporter_utils_cqptions.py +++ b/tests/utils/test_reporter_utils_cqptions.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """Tests for the reporter_utils module, function 'check_captions_and_files'""" from logging import getLogger diff --git a/tests/utils/test_reporter_utils_delete_file.py b/tests/utils/test_reporter_utils_delete_file.py index 8f0a553..d3d086f 100644 --- a/tests/utils/test_reporter_utils_delete_file.py +++ b/tests/utils/test_reporter_utils_delete_file.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """Tests for the reporter_utils module, function 'delete_file'""" from os import path diff --git a/tests/utils/test_reporter_utils_format_error.py b/tests/utils/test_reporter_utils_format_error.py index 3cfae21..e5ecdbe 100644 --- a/tests/utils/test_reporter_utils_format_error.py +++ b/tests/utils/test_reporter_utils_format_error.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """Tests for the reporter_utils module, function 'format_error'""" from testrail_api_reporter.utils.reporter_utils import format_error # pylint: disable=import-error,no-name-in-module diff --git a/tests/utils/test_reporter_utils_init_get_cases.py b/tests/utils/test_reporter_utils_init_get_cases.py index 0eaa272..4f11112 100644 --- a/tests/utils/test_reporter_utils_init_get_cases.py +++ b/tests/utils/test_reporter_utils_init_get_cases.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """Tests for the reporter_utils module, function 'init_get_cases_process'""" from testrail_api_reporter.utils.reporter_utils import ( # pylint: disable=import-error,no-name-in-module diff --git a/tests/utils/test_reporter_utils_upload_image.py b/tests/utils/test_reporter_utils_upload_image.py index 2f3f299..9bc9fa3 100644 --- a/tests/utils/test_reporter_utils_upload_image.py +++ b/tests/utils/test_reporter_utils_upload_image.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """Tests for the reporter_utils module, function 'upload_image'""" from os import getcwd, getenv diff --git a/tests/utils/test_reporter_utils_zip_file.py b/tests/utils/test_reporter_utils_zip_file.py index 2d344e5..154b49b 100644 --- a/tests/utils/test_reporter_utils_zip_file.py +++ b/tests/utils/test_reporter_utils_zip_file.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """Tests for the reporter_utils module, function 'zip_file'""" import os