Skip to content

Feature/add script helper#16

Merged
sinarest1608 merged 3 commits into
developfrom
feature/add_script_helper
Feb 23, 2024
Merged

Feature/add script helper#16
sinarest1608 merged 3 commits into
developfrom
feature/add_script_helper

Conversation

@michael-bentz
Copy link
Copy Markdown
Contributor

@michael-bentz michael-bentz commented Feb 22, 2024

**What does this change do?

This PR adds:

  • ScriptHelper: provides a simple interface for logging a successful or failed job to a sql database.
  • configure_logging: function that applies sensible defaults to the root logger

Why was this change made?

Fix #15

Verification

List the steps needed to make sure this thing works. Be precise.

  1. Verify that all automated tests pass

Affirmations

All of these should have a check by them. Any exception requires an explanation.

  • I have added docstrings with details on keyword arguments to new functions following the convention detailed in this gist
  • I have added type hinting to new function parameters.
  • I have added tests to new functions, following the rules of F.I.R.S.T..
  • I matched the style of the existing code.
  • I added and updated any relevant documentation (inline, README, CHANGELOG, and such).
  • I used Python's type hinting.
  • I ran the automated tests and ensured they ALL passed.
  • I ran the linter and ensured my changes have not introduced ANY warnings or errors.
  • I have made an effort to minimize code changes and have not included any cruft (preference files, *.pyc files, old comments, print-debugging, unused variables).
  • I have made an effort maintain a clear commit history (haven't merged other branches or rebased improperly).
  • I have written the code myself or have given credit where credit is due.

Copy link
Copy Markdown
Contributor

@sinarest1608 sinarest1608 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All tests passed.

@michael-bentz michael-bentz changed the base branch from master to develop February 23, 2024 15:18
@michael-bentz
Copy link
Copy Markdown
Contributor Author

Picked the wrong base, updated to develop.

@sinarest1608 sinarest1608 merged commit 8c7a1a4 into develop Feb 23, 2024
@michael-bentz michael-bentz mentioned this pull request Feb 23, 2024
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Incorporate shared logging features across projects

2 participants