Skip to content

Commit

Permalink
Add pydocstyle workflow and docstring
Browse files Browse the repository at this point in the history
Related to #90
  • Loading branch information
ritikaaaa177 authored and refeed committed Oct 1, 2024
1 parent dc658cf commit 80edee1
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 0 deletions.
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
12 changes: 12 additions & 0 deletions src/tirith/logging.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
"""
Sets up logging configuration for the application.
"""


import logging
import logging.config
import sys
Expand Down Expand Up @@ -38,6 +43,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)

0 comments on commit 80edee1

Please sign in to comment.