Merge branch 'main' of https://github.com/devsecblueprint/guildmaster-cli

damienjburks · damienjburks · commit b01e5567baaa · 2025-08-11T21:32:01.000-07:00
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -5,7 +5,7 @@ name: Publish Artifacts
 on:
   push:
     tags:
-      - 'v*'
+      - '\d+\.\d+\.\d+' # Tags like 1.0.0, 1.0.0, etc.
 
 permissions:
   id-token: write
diff --git a/.pylintrc b/.pylintrc
@@ -0,0 +1,15 @@
+[MESSAGES CONTROL]
+disable=
+    too-few-public-methods,
+    broad-except,
+    import-error
+
+[MASTER]
+ignore-patterns=test_.*\.py
+
+[FORMAT]
+max-line-length=100
+
+[REPORTS]
+output-format=colorized
+reports=no
diff --git a/README.md b/README.md
@@ -1,9 +1,86 @@
-# GuildMaster CLI
+# 🧙 GuildMaster CLI
 
-🚧 This repository is still in progress, and won't be complete until for a little while. 🚧
+[![Python](https://img.shields.io/badge/Python-3.10%2B-blue.svg?style=for-the-badge)](https://www.python.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
+[![PRs Welcome](https://img.shields.io/badge/PRs-Welcome-brightgreen.svg?style=for-the-badge)](https://makeapullrequest.com)
+![Status](https://img.shields.io/badge/status-in--progress-yellow?style=for-the-badge)
+[![Join Our Discord](https://img.shields.io/discord/1269864144903864381?label=Join%20Discord\&logo=discord\&style=for-the-badge)](discord.gg/enMmUNq8jc)
 
-command to bump version:
+> ⚔️ **GuildMaster CLI** is an administrative command-line interface built for managing the [DSB Discord](https://discord.gg/devsecblueprint) server. Automate tedious tasks like role synchronization and more as this tool evolves.
 
+## 🚧 Project Status
+
+GuildMaster CLI is currently under active development. Right now, it includes core functionality to update all Discord roles via a single command.
+
+Stay tuned as new features (like event management, audit logging, and quest assignments 👀) are rolled out!
+
+## 🧰 Features
+
+- ✅ Update all Discord roles with a single command
+- 🚧 Built with [Python Fire](https://github.com/google/python-fire) for rapid CLI development
+- ✨ Designed for server maintainers, moderators, and admins in the DSB community
+
+
+## 📦 Installation
+
+1. **Clone the repo**:
+   ```bash
+   git clone https://github.com/The-DevSec-Blueprint/guildmaster-cli.git
+   cd guildmaster-cli
+   ```
+
+2. **(Optional) Create and activate a virtual environment**:
+
+   ```bash
+   python -m venv venv
+   source venv/bin/activate  # or venv\Scripts\activate on Windows
+   ```
+
+3. **Install dependencies**:
+
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+## 🚀 Usage
+
+You must have your Discord bot token and configuration ready in a `.env` file or exported as environment variables.
+
+```bash
+python guildmaster.py update_roles
+```
+
+This command will trigger a role sync across the DSB Discord server using your preconfigured bot permissions.
+
+
+## 🛠 Version Management
+
+This project uses [bumpver](https://github.com/mbarkhau/bumpver) for consistent versioning.
+
+```bash
+# Patch bump (e.g., 1.0.0 → 1.0.1)
 bumpver update --patch
-bumpver update --major
+
+# Minor bump (e.g., 1.0.1 → 1.1.0)
 bumpver update --minor
+
+# Major bump (e.g., 1.1.0 → 2.0.0)
+bumpver update --major
+```
+
+
+## 🧪 Contributing
+
+We welcome pull requests! If you'd like to contribute:
+
+1. Fork the repo
+2. Create a new branch (`git checkout -b feat/add-feature`)
+3. Commit your changes (`git commit -m 'add cool feature'`)
+4. Push to your branch (`git push origin feat/add-feature`)
+5. Open a PR!
+
+## 📜 License
+
+Licensed under the [MIT License](https://opensource.org/licenses/MIT).
+
+> Made with ❤️ for the builders who shift left and secure everything—code, cloud, and community.
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,56 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "guildmaster-cli"
+dynamic = ["version"]
+authors = [
+    {name = "Damien Burks", email = "damien@devsecblueprint.com"}
+]
+description = "A collection of scripts for managing Discord channels and other administrative tasks"
+readme = "README.md"
+requires-python = ">=3.12"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "fire",
+    "discord.py",
+]
+
+[project.urls]
+Homepage = "https://github.com/devsecblueprint/guildmaster-cli"
+
+[project.scripts]
+guildmaster = "guildmaster.cli:main"
+
+[tool.setuptools]
+zip-safe = true
+include-package-data = true
+
+[tool.setuptools.dynamic]
+version = {attr = "guildmaster.__version__"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+exclude = ["tests"]
+
+[tool.setuptools.package-data]
+"*" = ["*.md"]
+
+[tool.bumpver]
+current_version = "1.1.3"
+version_pattern = "MAJOR.MINOR.PATCH"
+commit = true
+tag = true
+
+[tool.bumpver.file_patterns]
+"pyproject.toml" = [
+    'current_version = "{version}"',
+]
+"src/guildmaster/__init__.py" = [
+    '__version__ = "{version}"',
+]
diff --git a/requirements.txt b/requirements.txt
@@ -1,27 +1,61 @@
-aiohappyeyeballs==2.4.6
-aiohttp==3.11.13
-aiosignal==1.3.2
+aiohappyeyeballs==2.6.1
+aiohttp==3.12.15
+aiosignal==1.4.0
+astroid==3.3.11
 attrs==25.1.0
-build==1.2.2.post1
 black==25.1.0
+build==1.2.2.post1
 bumpver==2024.1130
+certifi==2025.7.14
+cffi==1.17.1
+charset-normalizer==3.4.2
 click==8.1.8
 colorama==0.4.6
+cryptography==45.0.5
+dill==0.4.0
 discord.py==2.5.0
+docutils==0.22
 fire==0.7.0
 frozenlist==1.5.0
+id==1.5.0
 idna==3.10
 iniconfig==2.1.0
+isort==6.0.1
+jaraco.classes==3.4.0
+jaraco.context==6.0.1
+jaraco.functools==4.2.1
+jeepney==0.9.0
+keyring==25.6.0
 lexid==2021.1006
+markdown-it-py==3.0.0
+mccabe==0.7.0
+mdurl==0.1.2
+more-itertools==10.7.0
 multidict==6.1.0
+mypy_extensions==1.1.0
+nh3==0.3.0
 packaging==24.2
+pathspec==0.12.1
+platformdirs==4.3.8
 pluggy==1.5.0
 propcache==0.3.0
+pycparser==2.22
+Pygments==2.19.2
 pylint==3.3.6
 pyproject_hooks==1.2.0
 pytest==8.3.5
-setuptools==75.8.2
+readme_renderer==44.0
+requests==2.32.4
+requests-toolbelt==1.0.0
+rfc3986==2.0.0
+rich==14.1.0
+SecretStorage==3.3.3
+setuptools==80.9.0
 termcolor==2.5.0
 toml==0.10.2
+tomlkit==0.13.3
 tqdm==4.67.1
+twine==6.1.0
+typing_extensions==4.14.1
+urllib3==2.5.0
 yarl==1.18.3
diff --git a/setup.cfg b/setup.cfg
diff --git a/setup.py b/setup.py
diff --git a/src/guildmaster/__init__.py b/src/guildmaster/__init__.py
@@ -0,0 +1,6 @@
+"""
+This is the __init__.py file for the GuildMaster package.
+It initializes the package and sets the version.
+"""
+
+__version__ = "1.1.3"
diff --git a/src/guildmaster/_init_.py b/src/guildmaster/_init_.py
diff --git a/src/guildmaster/cli.py b/src/guildmaster/cli.py
@@ -1,3 +1,8 @@
+"""
+# guildmaster.cli
+A command line interface for managing Discord server tasks and settings.
+"""
+
 import sys
 import fire
 from tasks.role_manager import DiscordRoleManager
@@ -13,6 +18,10 @@ def __init__(self):
 
 
 def main():
+    """
+    Main entry point for the GuildMaster CLI.
+    Initializes the command line interface and handles exceptions.
+    """
     try:
         fire.Fire(name="guildmaster", component=GuildMasterCommands)
     except KeyboardInterrupt:
diff --git a/src/guildmaster/client/discord_client.py b/src/guildmaster/client/discord_client.py
@@ -1,3 +1,9 @@
+"""
+# guildmaster.client.discord_client
+A module for managing the Discord client connection.
+This module provides functionality to connect to Discord using a bot token.
+"""
+
 import os
 import discord
 from discord.ext import commands
@@ -6,13 +12,23 @@
 
 
 class DiscordClient:
+    """
+    A class for managing the Discord client connection.
+    """
+
     def __init__(self):
         intents = discord.Intents.default()
         intents.members = True
         self.bot = commands.Bot(command_prefix="!", intents=intents)
 
     def run(self):
+        """
+        Run the Discord bot using the provided token.
+        """
         self.bot.run(TOKEN)
 
     def close(self):
+        """
+        Close the Discord bot connection.
+        """
         self.bot.close()
diff --git a/src/guildmaster/config/logger.py b/src/guildmaster/config/logger.py
@@ -1,7 +1,15 @@
+"""
+A module for configuring logging in the GuildMaster application.
+"""
+
 import logging
 
 
 class Logger:
+    """
+    A class for setting up a logger for the GuildMaster application.
+    """
+
     @staticmethod
     def setup_logger(name: str, level: int = logging.INFO) -> logging.Logger:
         """
diff --git a/src/guildmaster/tasks/role_manager.py b/src/guildmaster/tasks/role_manager.py
@@ -1,3 +1,9 @@
+"""
+# guildmaster.tasks.role_manager
+A module for managing roles in a Discord server.
+This module provides functionality to assign a specific role to all members of a Discord server.
+"""
+
 import asyncio
 import discord
 from tqdm.asyncio import tqdm
