Merge pull request #29 from jeFF0Falltrades/precommit-formatting

Adds pre-commit hook and bumps version for next release

Author: jeFF0Falltrades

.github/workflows/precommit.yml

@@ -0,0 +1,23 @@
+name: Pre-Commit Checks
+
+on: push
+
+jobs:
+  pre-commit:
+    name: Run Pre-Commit Hooks
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install pre-commit
+        run: pip install pre-commit
+
+      - name: Run pre-commit hooks
+        run: pre-commit run --all-files

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.2
+    hooks:
+      - id: ruff
+        args: 
+          - "--fix"
+          - "--exclude"
+          - "pyproject.toml"
+        language_version: python3

README.md

@@ -562,9 +562,30 @@ $ rat-king-parser -n dangerzone/* | jq
 ]
 ```
 
+
+
+## Development Guide
+**More Verbose Guide To Be Published**
+
+### Development Dependencies
+
+RKP uses `pre-commit` to enforce formatting.
+
+To begin development and install `pre-commit`, use the following command:
+
+```bash
+pip install .[dev]
+```
+
+Then, ensure you install the pre-commit hook:
+
+```bash
+pre-commit install
+```
+
 ## Feedback, Issues, and Additions
 
-If you have suggestions for improvement, bugs, feedback, or additional RAT families that use a similar configuration format as AsyncRAT, QuasarRAT, VenomRAT, DcRAT, etc. that are not yet supported, please send me a message on [Mastodon](https://infosec.exchange/@jeFF0Falltrades), [YouTube](https://www.youtube.com/c/jeff0falltrades), or submit an Issue or PR in this repo.
+If you have suggestions for improvement, bugs, feedback, or additional RAT families that use a similar configuration format as AsyncRAT, QuasarRAT, VenomRAT, DcRAT, etc. that are not yet supported, please send me a message on [Bluesky](https://bsky.app/profile/jeff0falltrades.bsky.social), [YouTube](https://www.youtube.com/c/jeff0falltrades), or submit an Issue or PR in this repo.
 
 Also, if this tool or video tutorial was helpful to you, that's always nice to hear as well!
 

pyproject.toml

@@ -36,7 +36,7 @@ classifiers = [
 ]
 dynamic = [ "version" ]
 dependencies = [ "dnfile", "pycryptodomex", "yara-python" ]
-
+optional-dependencies.dev = [ "pre-commit" ]
 optional-dependencies.maco = [ "maco", "validators" ]
 urls."Bug Reports" = "https://github.com/jeFF0Falltrades/rat_king_parser/issues"
 urls."Homepage" = "https://github.com/jeFF0Falltrades/rat_king_parser"
@@ -56,3 +56,6 @@ namespaces = false
 
 [tool.ruff]
 lint.extend-select = [ "I" ]
+
+[tool.pre-commit]
+hook-config = "file:.pre-commit-config.yaml"

src/rat_king_parser/_version.py

@@ -23,4 +23,4 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-__version__ = "4.0.2"
+__version__ = "4.1.0"

src/rat_king_parser/config_parser/utils/decryptors/__init__.py

@@ -24,8 +24,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 from .config_decryptor import ConfigDecryptor, IncompatibleDecryptorException
-from .config_decryptor_aes_with_iv_pbkdf2 import ConfigDecryptorAESWithIV_pbkdf
 from .config_decryptor_aes_with_iv import ConfigDecryptorAESWithIV
+from .config_decryptor_aes_with_iv_pbkdf2 import ConfigDecryptorAESWithIV_pbkdf
 from .config_decryptor_decrypt_xor import ConfigDecryptorDecryptXOR
 from .config_decryptor_ecb import ConfigDecryptorECB
 from .config_decryptor_plaintext import ConfigDecryptorPlaintext

src/rat_king_parser/config_parser/utils/decryptors/config_decryptor_aes_with_iv_bpkdf2.py

@@ -27,7 +27,7 @@
 # SOFTWARE.
 import re
 from base64 import b64decode
-from logging import getLogger, DEBUG
+from logging import getLogger
 
 from Cryptodome.Cipher import AES
 from Cryptodome.Cipher.AES import MODE_CBC as CBC