chore: add pre-commit

This commit is contained in:
Luke Tainton 2024-08-04 18:47:43 +01:00
parent 0188d8e43d
commit 6c1c5edf04
7 changed files with 92 additions and 32 deletions

View File

@ -5,4 +5,4 @@ ADMIN_EMAIL=""
ADMIN_FIRST_NAME="" ADMIN_FIRST_NAME=""
BOT_NAME="" BOT_NAME=""
N8N_WEBHOOK_URL="" N8N_WEBHOOK_URL=""
WEBEX_API_KEY="" WEBEX_API_KEY=""

2
.github/CODEOWNERS vendored
View File

@ -1 +1 @@
* @luketainton * @luketainton

34
.github/renovate.json vendored
View File

@ -1,47 +1,47 @@
{ {
"assignAutomerge": true,
"assigneesFromCodeOwners": true,
"baseBranches": [
"main"
],
"dependencyDashboardAutoclose": true,
"extends": [ "extends": [
"config:base", "config:base",
":semanticCommits", ":semanticCommits",
":semanticCommitTypeAll(fix)" ":semanticCommitTypeAll(fix)"
], ],
"baseBranches": [
"main"
],
"platformCommit": true,
"dependencyDashboardAutoclose": true,
"assignAutomerge": true,
"assigneesFromCodeOwners": true,
"rebaseWhen": "behind-base-branch",
"rollbackPrs": true,
"labels": [ "labels": [
"dependencies" "dependencies"
], ],
"packageRules": [ "packageRules": [
{ {
"labels": [
"linting"
],
"matchPackagePatterns": [ "matchPackagePatterns": [
"black", "black",
"pylint" "pylint"
],
"labels": [
"linting"
] ]
}, },
{ {
"labels": [
"unit-tests"
],
"matchPackagePatterns": [ "matchPackagePatterns": [
"coverage", "coverage",
"pytest" "pytest"
],
"labels": [
"unit-tests"
] ]
} }
], ],
"platformCommit": true,
"rebaseWhen": "behind-base-branch",
"rollbackPrs": true,
"vulnerabilityAlerts": { "vulnerabilityAlerts": {
"commitMessagePrefix": "[SECURITY] ",
"enabled": true, "enabled": true,
"labels": [ "labels": [
"security" "security"
], ],
"commitMessagePrefix": "[SECURITY] ",
"prCreation": "immediate" "prCreation": "immediate"
} }
} }

60
.pre-commit-config.yaml Normal file
View File

@ -0,0 +1,60 @@
fail_fast: false
minimum_pre_commit_version: 3.8.0
default_install_hook_types: [pre-commit, commit-msg]
default_language_version:
python: python3.11
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
hooks:
- id: trailing-whitespace
- id: mixed-line-ending
- id: end-of-file-fixer
- id: requirements-txt-fixer
- id: check-yaml
- id: check-added-large-files
- id: check-ast
- id: check-docstring-first
- id: check-json
- id: check-merge-conflict
- id: check-toml
- id: check-xml
- id: detect-private-key
- id: no-commit-to-branch
- id: requirements-txt-fixer
- id: name-tests-test
args: [--pytest-test-first]
- id: pretty-format-json
args: [--autofix]
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.5.6
hooks:
- id: ruff-format # Run the formatter.
- id: ruff # Run the linter.
args: [--fix]
- repo: https://github.com/pycqa/isort
rev: 5.13.2
hooks:
- id: isort
- repo: https://github.com/pre-commit/pygrep-hooks
rev: v1.10.0
hooks:
- id: python-use-type-annotations
- repo: https://github.com/asottile/pyupgrade
rev: v3.17.0
hooks:
- id: pyupgrade
- repo: https://github.com/compilerla/conventional-pre-commit
rev: v3.4.0
hooks:
- id: conventional-pre-commit
stages: [commit-msg]

View File

@ -1,18 +1,18 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
from zoneinfo import ZoneInfo
from datetime import datetime from datetime import datetime
from zoneinfo import ZoneInfo
def timestamp_to_date(timestamp: int) -> str: def timestamp_to_date(timestamp: int) -> str:
"""Convert timestamp to date. """Convert timestamp to date.
Args: Args:
timestamp (int): Timestamp to convert. timestamp (int): Timestamp to convert.
Returns: Returns:
str: Date in the format YYYY-MM-DD. str: Date in the format YYYY-MM-DD.
""" """
return datetime.fromtimestamp(timestamp=timestamp, tz=ZoneInfo("UTC")).strftime("%Y-%m-%d") return datetime.fromtimestamp(timestamp=timestamp, tz=ZoneInfo("UTC")).strftime(
"%Y-%m-%d"
)

View File

@ -6,10 +6,10 @@ from app.utils.config import config
def __n8n_post(data: dict) -> bool: def __n8n_post(data: dict) -> bool:
"""Post data to N8N webhook URL. """Post data to N8N webhook URL.
Args: Args:
data (dict): Data to post to webhook URL. data (dict): Data to post to webhook URL.
Returns: Returns:
bool: True if successful, else False. bool: True if successful, else False.
""" """
@ -26,13 +26,13 @@ def __n8n_post(data: dict) -> bool:
def submit_task(summary, description, completion_date, requestor) -> bool: def submit_task(summary, description, completion_date, requestor) -> bool:
"""Submit task to N8N webhook URL. """Submit task to N8N webhook URL.
Args: Args:
summary (str): Summary of task. summary (str): Summary of task.
description (str): Description of task. description (str): Description of task.
completion_date (str): Completion date of task. completion_date (str): Completion date of task.
requestor (str): Requestor of task. requestor (str): Requestor of task.
Returns: Returns:
bool: True if successful, else False. bool: True if successful, else False.
""" """
@ -49,10 +49,10 @@ def submit_task(summary, description, completion_date, requestor) -> bool:
def get_tasks(requestor) -> bool: def get_tasks(requestor) -> bool:
"""Get tasks from N8N webhook URL. """Get tasks from N8N webhook URL.
Args: Args:
requestor (str): Requestor of tasks. requestor (str): Requestor of tasks.
Returns: Returns:
bool: True if successful, else False. bool: True if successful, else False.
""" """

View File

@ -7,4 +7,4 @@ services:
dockerfile: Dockerfile dockerfile: Dockerfile
restart: unless-stopped restart: unless-stopped
env_file: .env env_file: .env
... ...