Merge branch 'development'

Author: nikolasfil

.github/workflows/static.yml

@@ -4,7 +4,7 @@ name: Deploy static content to Pages
 on:
   # Runs on pushes targeting the default branch
   push:
-    branches: ["documentation"]
+    branches: ["main"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -36,7 +36,7 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: docs/sphinx/build/html
+          path: "./docs/ctfsolver"
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4

README.md

@@ -1,11 +1,34 @@
-How to install the project
+# CTFSolverScript
 
-```bash
-python setup.py bdist_wheel sdist
-```
+CTFSolverScript is a tool designed to assist in solving Capture The Flag (CTF) challenges. It provides utilities and scripts to streamline the process of solving various types of CTF problems.
+
+## Features
 
-For local installation use:
+- **Automated Scripts**: Pre-built scripts for common CTF tasks.
+- **Modular Design**: Easily extendable to add custom scripts.
+- **Cross-Platform**: Works on Linux, macOS, and Windows.
+- **Lightweight**: Minimal dependencies for quick setup.
+
+## Installation
+
+[official pypi link](https://pypi.org/project/ctfsolver)
 
 ```bash
-pip install .
+pip install ctfsolver
 ```
+
+## Usage
+
+Either as a class or as a command-line tool.
+More documentation on the way.
+For now the documentation is autogenerated from docstrings using pdoc3
+
+[ctfsolver](https://nikolasfil.github.io/CTFSolverScript/ctfsolver/)
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contact
+
+Feel free to open a ticket on the [GitHub Issues page](https://github.com/nikolasfil/CTFSolverScript/issues) for any questions or suggestions.

app/ctfsolver.egg-info/PKG-INFO

@@ -19,6 +19,7 @@ Requires-Dist: setuptools>=67.7.0
 Requires-Dist: wheel>=0.37.0
 Requires-Dist: dash_cytoscape>=1.0.2
 Requires-Dist: dash>=3.2.0
+Requires-Dist: colorama>=0.4.6
 Provides-Extra: dev
 Requires-Dist: pytest>=6.2.4; extra == "dev"
 Requires-Dist: twine>=3.4.2; extra == "dev"
@@ -34,6 +35,7 @@ Requires-Dist: sphinx-basic-ng>=1.0.0.beta2; extra == "docs"
 Requires-Dist: sphinx-rtd-theme>=3.0.2; extra == "docs"
 Requires-Dist: python-call-graph>=2.1.4; extra == "docs"
 Requires-Dist: sphinx-autoapi>=3.0.0; extra == "docs"
+Requires-Dist: pdoc3>=0.11.6; extra == "docs"
 Provides-Extra: docs-live
 Requires-Dist: sphinx-autobuild>=2024.9.3; extra == "docs-live"
 Dynamic: license-file

app/ctfsolver.egg-info/requires.txt

@@ -6,6 +6,7 @@ setuptools>=67.7.0
 wheel>=0.37.0
 dash_cytoscape>=1.0.2
 dash>=3.2.0
+colorama>=0.4.6
 
 [dev]
 pytest>=6.2.4
@@ -23,6 +24,7 @@ sphinx-basic-ng>=1.0.0.beta2
 sphinx-rtd-theme>=3.0.2
 python-call-graph>=2.1.4
 sphinx-autoapi>=3.0.0
+pdoc3>=0.11.6
 
 [docs-live]
 sphinx-autobuild>=2024.9.3

dist/ctfsolver-0.0.13-py3-none-any.whl

@@ -33,7 +33,7 @@
 <main>
 <article id="content">
 <header>
-<h1 class="title">Namespace <code>ctfsolver.forensics</code></h1>
+<h1 class="title">Module <code>ctfsolver.forensics</code></h1>
 </header>
 <section id="section-intro">
 </section>

dist/ctfsolver-0.0.13.tar.gz

@@ -33,7 +33,7 @@
 <main>
 <article id="content">
 <header>
-<h1 class="title">Namespace <code>ctfsolver.src.data</code></h1>
+<h1 class="title">Module <code>ctfsolver.src.data</code></h1>
 </header>
 <section id="section-intro">
 </section>

docs/pdoc/html/ctfsolver/forensics/index.html

@@ -0,0 +1,95 @@
+Module ctfsolver.config.global_config
+=====================================
+Global configuration management for the CTFSolverScript package.
+
+This module provides the `GlobalConfig` class, which handles the creation, initialization,
+and access of a global configuration file stored in the user's home directory. The configuration
+file is used to store persistent settings required by the CTFSolverScript inline tool.
+
+Classes:
+    GlobalConfig: Manages the global configuration file, including creation, initialization,
+                  reading, and attribute/dictionary-style access to configuration values.
+
+Attributes:
+    CONFIG (GlobalConfig): Singleton instance of the GlobalConfig class for global access.
+
+Example:
+    >>> from ctfsolver.config.global_config import CONFIG
+    >>> from ctfsolver.config import CONFIG
+    >>> CONFIG.initializing()  # Initializes the global configuration
+
+Typical usage involves initializing the configuration (creating the file and writing initial
+content if necessary) and accessing configuration values via attribute or dictionary-style access.
+
+Raises:
+    AttributeError: If an attribute is accessed that does not exist in the configuration.
+    KeyError: If a key is accessed that does not exist in the configuration.
+
+Classes
+-------
+
+`GlobalConfig(*args, **kwargs)`
+:   Initializes the global configuration for the CTF solver application.
+    This constructor sets the path to the global configuration file and loads its content.
+    
+    Attributes:
+        global_config_file_path (Path): Path to the global configuration JSON file.
+    
+    Raises:
+        Any exceptions raised by `get_content()` will propagate.
+
+    ### Methods
+
+    `creating(self)`
+    :   Creates a global configuration file in the user's home directory.
+        
+        This method ensures that the required directories and configuration file exist,
+        creating them if necessary. It is typically called during the initial run of the
+        inline tool or when global configuration setup is required.
+        
+        Args:
+            None
+        
+        Returns:
+            None
+        
+        Raises:
+            OSError: If the directory or file cannot be created due to permission issues.
+
+    `get_content(self)`
+    :   Get the content of the global configuration file.
+        This method reads the global configuration file and returns its content
+        as a dictionary.
+        If the file does not exist or is empty, it returns an empty dictionary.
+        It is intended to be used to retrieve the current global configuration
+        settings for use in the inline tool or other parts of the application.
+        
+        
+        Returns:
+            dict: The content of the global configuration file as a dictionary.
+
+    `initial_content(self)`
+    :   Sets the initial content of the global configuration file.
+        
+        This method loads a configuration template from 'config_template.json' and writes it to the global
+        configuration file if the file is empty or does not exist. If the template file is missing, a default
+        initial content is used instead.
+        
+        Args:
+            None
+        
+        Returns:
+            None
+        
+        Raises:
+            FileNotFoundError: If the template file or global configuration file path does not exist.
+            json.JSONDecodeError: If the template file contains invalid JSON.
+        
+        Side Effects:
+            Writes initial configuration content to the global configuration file if it is empty.
+            Prints status messages to the console.
+
+    `initializing(self)`
+    :   Initialize global configuration settings.
+        This method can be used to set up any necessary global configurations
+        required by the inline tool.

docs/pdoc/html/ctfsolver/src/data/index.html

@@ -0,0 +1,6 @@
+Module ctfsolver.config
+=======================
+
+Sub-modules
+-----------
+* ctfsolver.config.global_config