Merge pull request #5 from UmmItKin/master

Add CI Workflow and Enhance Development Environment

Author: UmmItKin

.github/workflows/ci.yml

@@ -0,0 +1,70 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.13"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+      with:
+        enable-cache: true
+        cache-dependency-glob: "uv.lock"
+
+    - name: Set up Python ${{ matrix.python-version }}
+      run: uv python install ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: uv sync
+
+    - name: Lint with ruff (if available)
+      run: |
+        if uv run --quiet ruff --version 2>/dev/null; then
+          uv run ruff check .
+        else
+          echo "Ruff not installed, skipping linting"
+        fi
+      continue-on-error: true
+
+    - name: Check code formatting with ruff (if available)
+      run: |
+        if uv run --quiet ruff --version 2>/dev/null; then
+          uv run ruff format --check
+        else
+          echo "Ruff not installed, skipping format check"
+        fi
+      continue-on-error: true
+
+  security-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+
+    - name: Set up Python
+      run: uv python install 3.13
+
+    - name: Install dependencies
+      run: uv sync
+
+    - name: Security check with bandit (if available)
+      run: |
+        if uv run --quiet bandit --version 2>/dev/null; then
+          uv run bandit -r . -f json || true
+        else
+          echo "Bandit not installed, skipping security check"
+        fi
+      continue-on-error: true

ctfeed.py

@@ -11,37 +11,43 @@
 from src.embed_creator import create_event_embed
 
 logging.basicConfig(level=logging.INFO)
-logging.getLogger('discord.client').setLevel(logging.ERROR)
+logging.getLogger("discord.client").setLevel(logging.ERROR)
 logger = logging.getLogger(__name__)
 
 bot = discord.Client(intents=discord.Intents.default())
 
 known_events = load_known_events()
 
+
 @bot.event
 async def on_ready():
-    logger.info(f'Bot logged in: {bot.user}')
+    logger.info(f"Bot logged in: {bot.user}")
     if known_events:
-        logger.info(f"Loading data/known_events.json for {len(known_events)} known competitions")
+        logger.info(
+            f"Loading data/known_events.json for {len(known_events)} known competitions"
+        )
     else:
-        logger.info("No known competitions found, creating new file data/known_events.json")
+        logger.info(
+            "No known competitions found, creating new file data/known_events.json"
+        )
         save_known_events(set())
     check_new_events.start()
 
+
 @tasks.loop(minutes=CHECK_INTERVAL)
 async def check_new_events():
     global known_events
-    
+
     events = await fetch_ctf_events()
-    
+
     channel_name = ANNOUNCEMENT_CHANNEL_ID
     if not channel_name:
         logger.error("Please set ANNOUNCEMENT_CHANNEL_ID in .env file")
         logger.error("For example: ANNOUNCEMENT_CHANNEL_ID=ctftime")
         logger.error("Please check if the .env file is correctly set")
         await bot.close()
         return
-    
+
     channel = None
     for guild in bot.guilds:
         for text_channel in guild.text_channels:
@@ -50,7 +56,7 @@ async def check_new_events():
                 break
         if channel:
             break
-    
+
     if not channel:
         logger.error(f"Can't find channel named '{channel_name}'")
         logger.error(f"Please check:")
@@ -59,10 +65,10 @@ async def check_new_events():
         logger.error(f"3. The channel exists in the server where the Bot is located")
         await bot.close()
         return
-    
+
     new_events_found = False
     for event in events:
-        event_id = event['id']
+        event_id = event["id"]
         if event_id not in known_events:
             known_events.add(event_id)
             new_events_found = True
@@ -73,21 +79,24 @@ async def check_new_events():
                 logger.info(f"Sent new event notification: {event['title']}")
             except Exception as e:
                 logger.error(f"Failed to send notification: {e}")
-    
+
     if new_events_found:
         save_known_events(known_events)
 
+
 @check_new_events.before_loop
 async def before_check():
     await bot.wait_until_ready()
 
+
 def main():
     if not DISCORD_BOT_TOKEN:
         print("Please set DISCORD_BOT_TOKEN in .env file")
         exit(1)
-    
+
     print("Start CTF Bot...")
     bot.run(DISCORD_BOT_TOKEN)
 
+
 if __name__ == "__main__":
-    main()
+    main()

pyproject.toml

@@ -12,6 +12,13 @@ dependencies = [
     "pytz>=2023.3"
 ]
 
+[dependency-groups]
+dev = [
+    "ruff>=0.1.0",
+    "mypy>=1.0.0",
+    "bandit>=1.7.0",
+]
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"

ruff.toml

@@ -0,0 +1,23 @@
+[lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "UP",  # pyupgrade
+]
+
+ignore = [
+    "E501",  # line too long, handled by formatter
+]
+
+[format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[lint.per-file-ignores]
+"__init__.py" = ["F401"]  # Allow unused imports in __init__.py files

src/config.py

@@ -3,13 +3,13 @@
 
 load_dotenv()
 
-DISCORD_BOT_TOKEN = os.getenv('DISCORD_BOT_TOKEN')
-ANNOUNCEMENT_CHANNEL_ID = os.getenv('ANNOUNCEMENT_CHANNEL_ID')
-KNOWN_EVENTS_FILE = os.getenv('KNOWN_EVENTS_FILE', 'data/known_events.json')
+DISCORD_BOT_TOKEN = os.getenv("DISCORD_BOT_TOKEN")
+ANNOUNCEMENT_CHANNEL_ID = os.getenv("ANNOUNCEMENT_CHANNEL_ID")
+KNOWN_EVENTS_FILE = os.getenv("KNOWN_EVENTS_FILE", "data/known_events.json")
 
 CTFTIME_API_URL = "https://ctftime.org/api/v1/events/"
 TEAM_API_URL = "https://ctftime.org/api/v1/teams/"
 
 CHECK_INTERVAL = 30
 
-SEARCH_DAYS = 90 
+SEARCH_DAYS = 90