Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pydocstyle workflow and docstring #188

Merged
merged 1 commit into from
Oct 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/workflows/pydosctyle.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Lint and Test

on: [push, pull_request]

jobs:
lint:
runs-on: ubuntu-latest

steps:
- name: Check out code
uses: actions/checkout@v2

- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.8'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pydocstyle

- name: Run pydocstyle
run: |
pydocstyle
2 changes: 2 additions & 0 deletions .pydocstyle
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[pydocstyle]
ignore = D203,D213,D406,D407,D415,D100,D101,D102,D103,D104,D107,D200,D205,D212,D400,D401,D402,D404
11 changes: 11 additions & 0 deletions src/tirith/logging.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
Sets up logging configuration for the application.
"""

import logging
import logging.config
import sys
Expand Down Expand Up @@ -38,6 +42,13 @@


def setup_logging(verbose: bool = False):
"""
Set up logging configuration.

:param verbose: If set to `True` will log all messages higher than DEBUG
level, otherwise it will log the messages that are higher
than INFO level ('INFO', 'WARNING', 'CRITICAL')
"""
if verbose:
DEFAULT_LOGGING_CONFIG["root"]["handlers"] = ["console_stderr_verbose"]
logging.config.dictConfig(DEFAULT_LOGGING_CONFIG)
Loading