📄 Automatic license header check w/ copywrite

Paillat-dev · Paillat-dev · commit c17340cbdc25 · 2024-10-15T22:30:11.000+02:00
diff --git a/.copywrite.hcl b/.copywrite.hcl
@@ -0,0 +1,16 @@
+schema_version = 1
+
+project {
+  license        = "MIT"
+  copyright_year = 2024
+  copyright_holder = "NiceBots"
+  header_ignore = [
+    ".venv/**",
+    "logs/**",
+    ".idea/**",
+    ".git/**",
+    ".vscode/**",
+    "__pycache__/**",
+    "*.pyc",
+  ]
+}
diff --git a/.github/workflows/license.yaml b/.github/workflows/license.yaml
@@ -0,0 +1,19 @@
+name: Check for LICENSE file header
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+
+jobs:
+    check-license-header:
+        runs-on: ubuntu-latest
+        steps:
+        - name: Checkout repository
+          uses: actions/checkout@v4
+        - name: Setup Copywrite
+          uses: hashicorp/setup-copywrite@867a1a2a064a0626db322392806428f7dc59cb3e
+        - name: Check Header Compliance
+          run: copywrite headers --plan --config .copywrite.hcl
diff --git a/Dockerfile b/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 # For more information, please refer to https://aka.ms/vscode-docker-python
 FROM python:3.12-slim-bookworm
 
diff --git a/config.example.yaml b/config.example.yaml
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 #file: noinspection SpellCheckingInspection
 extensions:
   topgg: # If your discord bot is on top.gg, you can enable this extension to post your stats (server count, shard count, etc.) on top.gg automatically.
diff --git a/scripts/__init__.py b/scripts/__init__.py
@@ -1 +1,4 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from . import check_listings
diff --git a/scripts/check_listings/__init__.py b/scripts/check_listings/__init__.py
@@ -1 +1,4 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from .__main__ import main
diff --git a/scripts/check_listings/__main__.py b/scripts/check_listings/__main__.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import asyncio
 import nodriver as uc
 import markdown
diff --git a/scripts/check_listings/listings/DiscordAppDirectory.py b/scripts/check_listings/listings/DiscordAppDirectory.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import nodriver as uc
 
 from bs4 import BeautifulSoup
diff --git a/scripts/check_listings/listings/DiscordBotListCom.py b/scripts/check_listings/listings/DiscordBotListCom.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import nodriver as uc
 import asyncio
 
diff --git a/scripts/check_listings/listings/DiscordBotsGg.py b/scripts/check_listings/listings/DiscordBotsGg.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import nodriver as uc
 
 from bs4 import BeautifulSoup
diff --git a/scripts/check_listings/listings/DiscordMe.py b/scripts/check_listings/listings/DiscordMe.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import nodriver as uc
 import asyncio
 
diff --git a/scripts/check_listings/listings/DiscordsCom.py b/scripts/check_listings/listings/DiscordsCom.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import nodriver as uc
 
 from bs4 import BeautifulSoup
diff --git a/scripts/check_listings/listings/DisforgeCom.py b/scripts/check_listings/listings/DisforgeCom.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import nodriver as uc
 
 from bs4 import BeautifulSoup
diff --git a/scripts/check_listings/listings/Listing.py b/scripts/check_listings/listings/Listing.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import nodriver as uc
 
 from abc import ABC, abstractmethod
diff --git a/scripts/check_listings/listings/TopGg.py b/scripts/check_listings/listings/TopGg.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import nodriver as uc
 
 from bs4 import BeautifulSoup
diff --git a/scripts/check_listings/listings/WumpusStore.py b/scripts/check_listings/listings/WumpusStore.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import nodriver as uc
 
 from bs4 import BeautifulSoup
diff --git a/scripts/check_listings/listings/__init__.py b/scripts/check_listings/listings/__init__.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots
+# SPDX-License-Identifier: MIT
+
 from .TopGg import TopGg
 from .DiscordsCom import DiscordsCom
 from .Listing import BaseError, NotFoundError, normalize_soup
diff --git a/scripts/check_listings/main.py b/scripts/check_listings/main.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import asyncio
 import nodriver as uc
 import markdown
diff --git a/src/__main__.py b/src/__main__.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import sys
 import os
 
diff --git a/src/config/__init__.py b/src/config/__init__.py
@@ -1 +1,4 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from .bot_config import *
diff --git a/src/config/bot_config.py b/src/config/bot_config.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import yaml
 import os
 import orjson
diff --git a/src/custom/__init__.py b/src/custom/__init__.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from typing_extensions import override
 import discord
 from src.i18n import apply_locale
diff --git a/src/extensions/add-dm/__init__.py b/src/extensions/add-dm/__init__.py
@@ -1 +1,4 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from .main import setup, default, schema
diff --git a/src/extensions/add-dm/main.py b/src/extensions/add-dm/main.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import discord
 
 from discord.ext import commands
diff --git a/src/extensions/branding/__init__.py b/src/extensions/branding/__init__.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from .branding import *
 
 __all__ = ["setup", "default", "schema"]
diff --git a/src/extensions/branding/branding.py b/src/extensions/branding/branding.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import logging
 import discord
 import pytz
diff --git a/src/extensions/listings/__init__.py b/src/extensions/listings/__init__.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from .main import *
 
 __all__ = ["setup", "default", "schema"]
diff --git a/src/extensions/listings/main.py b/src/extensions/listings/main.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import discord
 import aiohttp
 
diff --git a/src/extensions/nice-errors/__init__.py b/src/extensions/nice-errors/__init__.py
@@ -1 +1,4 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from .main import setup, default, schema
diff --git a/src/extensions/nice-errors/handler.py b/src/extensions/nice-errors/handler.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import discord
 
 sentry_sdk = None
diff --git a/src/extensions/nice-errors/main.py b/src/extensions/nice-errors/main.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import discord
 
 from discord.ext import commands
diff --git a/src/extensions/nice-errors/patch.py b/src/extensions/nice-errors/patch.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from typing import Any
 from .handler import handle_error
 
diff --git a/src/extensions/ping/__init__.py b/src/extensions/ping/__init__.py
@@ -1 +1,4 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from .ping import setup, setup_webserver, on_startup, default, schema
diff --git a/src/extensions/ping/ping.py b/src/extensions/ping/ping.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import discord
 import aiohttp
 
diff --git a/src/extensions/ping/translations.yml b/src/extensions/ping/translations.yml
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 commands:
   ping:
     name:
diff --git a/src/extensions/status-post/__init__.py b/src/extensions/status-post/__init__.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from .main import setup, default, schema
 
 __all__ = ["setup", "default", "schema"]
diff --git a/src/extensions/status-post/main.py b/src/extensions/status-post/main.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import discord
 import aiohttp
 
diff --git a/src/i18n/__init__.py b/src/i18n/__init__.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from .utils import apply, load_translation
 from .classes import apply_locale
 
diff --git a/src/i18n/classes.py b/src/i18n/classes.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from typing import Any
 from typing_extensions import override
 from pydantic import BaseModel, Field
diff --git a/src/i18n/utils.py b/src/i18n/utils.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from typing import TypeVar
 import discord
 from .classes import (
diff --git a/src/log/__init__.py b/src/log/__init__.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from .logger import logger, patch
 
 __all__ = ["logger", "patch"]
diff --git a/src/log/logger.py b/src/log/logger.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import logging
 import os
 import time
diff --git a/src/start.py b/src/start.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import discord
 import importlib
 import importlib.util
diff --git a/src/utils/__init__.py b/src/utils/__init__.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from .extensions import validate_module, unzip_extensions
 from .misc import mention_command
 from .setup_func import setup_func
diff --git a/src/utils/extensions.py b/src/utils/extensions.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import inspect
 import os
 import zipfile
diff --git a/src/utils/iterator.py b/src/utils/iterator.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from typing import TypeVar
 from collections.abc import Iterator
 
diff --git a/src/utils/misc.py b/src/utils/misc.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 import discord
 
 
diff --git a/src/utils/setup_func.py b/src/utils/setup_func.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from inspect import signature
 from typing import Any, Callable
 
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -0,0 +1,3 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
diff --git a/tests/schema_test.py b/tests/schema_test.py
@@ -1,3 +1,6 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
 from glob import iglob
 from os.path import splitext, basename
 import importlib
