wip

httpdss · httpdss · commit e2d871be378d · 2025-10-28T20:51:37.000-03:00
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 200
+extend-ignore = E111,E114
diff --git a/.github/workflows/struct-generate.yaml b/.github/workflows/struct-generate.yaml
@@ -53,6 +53,11 @@ on:
         type: string
         required: false
         default: 'structures'
+      version:
+        description: 'StructKit version to install'
+        type: string
+        required: false
+        default: 'main'
     secrets:
       token:
         description: 'GitHub token'
@@ -70,11 +75,18 @@ jobs:
         with:
           python-version: '3.x'
 
-      - name: Install StructKit
+      - name: Install StructKit (latest)
+        if: ${{ inputs.version == 'main' }}
         run: |
           pip install git+https://github.com/httpdss/structkit.git
           structkit -h
 
+      - name: Install StructKit (specific version)
+        if: ${{ inputs.version != 'main' }}
+        run: |
+          pip install structkit==${{ inputs.version }}
+          structkit -h
+
       - name: Install custom structures
         if: ${{ inputs.custom_structure_repository != '' }}
         uses: actions/checkout@v5
diff --git a/.github/workflows/test-script.yaml b/.github/workflows/test-script.yaml
@@ -36,6 +36,11 @@ jobs:
       run: flake8 --max-line-length=200 .
       continue-on-error: true
 
+    - name: Type check with mypy
+      run: |
+        mypy structkit tests
+      continue-on-error: true
+
     - name: Run tests
       env:
         REPORT_OUTPUT: md_report.md
diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@
 
 ```bash
 # Install via pip
-pip install git+https://github.com/httpdss/structkit.git
+pip install structkit
 
 # Or run with Docker
 docker run -v $(pwd):/workdir ghcr.io/httpdss/structkit:main generate my-config.yaml ./output
diff --git a/docs/installation.md b/docs/installation.md
@@ -10,7 +10,7 @@ tags:
 Install StructKit with pip:
 
 ```sh
-pip install git+https://github.com/httpdss/structkit.git
+pip install structkit
 ```
 
 !!! tip "Enable Auto-Completion"
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -42,7 +42,7 @@ Inside the container:
 
 ```sh
 apk add python-pip git vim
-pip install git+https://github.com/httpdss/structkit.git
+pip install structkit
 mkdir example
 cd example/
 touch structure.yaml
diff --git a/docs/vhs/install.tape b/docs/vhs/install.tape
@@ -22,9 +22,9 @@ Type "source .venv/bin/activate"
 Enter
 Sleep 1s
 
-Type "# Install StructKit from GitHub"
+Type "# Install StructKit"
 Enter
-Type "pip install git+https://github.com/httpdss/structkit.git"
+Type "pip install structkit"
 Enter
 Sleep 5s
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -57,8 +57,12 @@ dev = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/httpdss/structkit"
-Repository = "https://github.com/httpdss/structkit.git"
+Homepage = "https://httpdss.github.io/structkit/"
+Repository = "https://github.com/httpdss/structkit"
+Issues = "https://github.com/httpdss/structkit/issues"
+Discussions = "https://github.com/httpdss/structkit/discussions"
+Documentation = "https://httpdss.github.io/structkit/docs/"
+Funding = "https://httpdss.github.io/structkit/docs/funding/"
 
 [project.scripts]
 structkit = "structkit.main:main"
diff --git a/requirements.dev.txt b/requirements.dev.txt
@@ -3,3 +3,4 @@ flake8
 pytest-md-report
 pre-commit
 pytest-cov
+mypy
diff --git a/site/index.html b/site/index.html
@@ -232,7 +232,7 @@ <h3 class="mb-4">Install via pip</h3>
             <div class="code-block">
               <button class="copy-button">Copy</button>
               <pre><code># Install from GitHub
-pip install git+https://github.com/httpdss/structkit.git
+pip install structkit
 
 # Verify installation
 structkit --version</code></pre>
diff --git a/structkit/commands/__init__.py b/structkit/commands/__init__.py
@@ -1,6 +1,7 @@
 import logging
 from structkit.completers import log_level_completer
 
+
 # Base command class
 class Command:
     def __init__(self, parser):
diff --git a/structkit/commands/completion.py b/structkit/commands/completion.py
@@ -3,6 +3,7 @@
 
 SUPPORTED_SHELLS = ["bash", "zsh", "fish"]
 
+
 class CompletionCommand(Command):
   def __init__(self, parser):
     super().__init__(parser)
diff --git a/structkit/commands/generate.py b/structkit/commands/generate.py
@@ -8,6 +8,7 @@
 
 import subprocess
 
+
 # Generate command class
 class GenerateCommand(Command):
   def __init__(self, parser):
@@ -22,7 +23,13 @@ def __init__(self, parser):
     parser.add_argument('--diff', action='store_true', help='Show unified diffs for files that would change during dry-run or console output')
     parser.add_argument('-v', '--vars', type=str, help='Template variables in the format KEY1=value1,KEY2=value2')
     parser.add_argument('-b', '--backup', type=str, help='Path to the backup folder')
-    parser.add_argument('-f', '--file-strategy', type=str, choices=['overwrite', 'skip', 'append', 'rename', 'backup'], default='overwrite', help='Strategy for handling existing files').completer = file_strategy_completer
+    parser.add_argument(
+      '-f',
+      '--file-strategy',
+      type=str,
+      choices=['overwrite', 'skip', 'append', 'rename', 'backup'],
+      default='overwrite',
+      help='Strategy for handling existing files').completer = file_strategy_completer
     parser.add_argument('-p', '--global-system-prompt', type=str, help='Global system prompt for OpenAI')
     parser.add_argument('--non-interactive', action='store_true', help='Run the command in non-interactive mode')
     parser.add_argument('--mappings-file', type=str, action='append',
@@ -113,7 +120,7 @@ def _load_yaml_config(self, structure_definition, structures_path):
         return yaml.safe_load(f)
 
   def execute(self, args):
-    self.logger.info(f"Generating structure")
+    self.logger.info("Generating structure")
     self.logger.info(f"  Structure definition: {args.structure_definition}")
     self.logger.info(f"  Base path: {args.base_path}")
 
@@ -167,8 +174,6 @@ def execute(self, args):
   def _create_structure(self, args, mappings=None, summary=None, print_summary=True):
     if isinstance(args, dict):
         args = argparse.Namespace(**args)
-    this_file = os.path.dirname(os.path.realpath(__file__))
-    contribs_path = os.path.join(this_file, "..", "contribs")
 
     config = self._load_yaml_config(args.structure_definition, args.structures_path)
     if config is None:
@@ -302,9 +307,9 @@ def _create_structure(self, args, mappings=None, summary=None, print_summary=Tru
 
         # check if content has structkit value
         if 'struct' in content:
-          self.logger.info(f"Generating structure")
+          self.logger.info("Generating structure")
           self.logger.info(f"  Folder: {folder}")
-          self.logger.info(f"  Struct(s):")
+          self.logger.info("  Struct(s):")
           if isinstance(content['struct'], list):
             # iterate over the list of structures
             for struct in content['struct']:
diff --git a/structkit/commands/import.py b/structkit/commands/import.py
@@ -1,6 +1,5 @@
 from structkit.commands import Command
-import os
-import yaml
+
 
 # Import command class
 # This class is responsible for importing a structure definition given a file path. It will create the structure in the base path provided.
@@ -16,7 +15,6 @@ def execute(self, args):
 
     self._import_structure(args)
 
-
   def _import_structure(self, args):
     raise NotImplementedError("This method needs to be implemented")
     # # Check if the import_from directory exists
diff --git a/structkit/commands/info.py b/structkit/commands/info.py
@@ -4,8 +4,10 @@
 
 from structkit.commands import Command
 
+
 # Info command class for exposing information about the structure
 class InfoCommand(Command):
+
     def __init__(self, parser):
       super().__init__(parser)
       parser.description = "Show information about the package or structure definition"
@@ -45,7 +47,7 @@ def _get_info(self, args):
       print(f"   📌 Description: {config.get('description', 'No description')}\n")
 
       if config.get('files'):
-        print(f"   📌 Files:")
+        print("   📌 Files:")
         for item in config.get('files', []):
           for name, content in item.items():
             print(f"       - {name} ")
@@ -54,7 +56,7 @@ def _get_info(self, args):
             #   print(f"       {line}")
 
       if config.get('folders'):
-        print(f"   📌 Folders:")
+        print("   📌 Folders:")
         for folder in config.get('folders', []):
           print(f"     - {folder}")
           # print(f"     - {folder}: {folder.get('struct', 'No structure')}")
diff --git a/structkit/commands/init.py b/structkit/commands/init.py
@@ -26,6 +26,7 @@
     """
 ).lstrip()
 
+
 class InitCommand(Command):
   def __init__(self, parser):
     super().__init__(parser)
diff --git a/structkit/commands/list.py b/structkit/commands/list.py
@@ -1,9 +1,7 @@
 from structkit.commands import Command
 import os
-import yaml
 import asyncio
-from structkit.file_item import FileItem
-from structkit.utils import project_path
+
 
 # List command class
 class ListCommand(Command):
@@ -16,7 +14,7 @@ def __init__(self, parser):
     parser.set_defaults(func=self.execute)
 
   def execute(self, args):
-    self.logger.info(f"Listing available structures")
+    self.logger.info("Listing available structures")
     if args.mcp:
       self._list_structures_mcp(args)
     else:
diff --git a/structkit/commands/mcp.py b/structkit/commands/mcp.py
@@ -1,5 +1,4 @@
 import asyncio
-import logging
 from structkit.commands import Command
 from structkit.mcp_server import StructMCPServer
 
@@ -9,24 +8,23 @@ class MCPCommand(Command):
     def __init__(self, parser):
         super().__init__(parser)
         parser.description = "MCP (Model Context Protocol) using FastMCP transports (stdio, http, sse)"
-        parser.add_argument('--server', action='store_true',
-                          help='Start the MCP server')
-        parser.add_argument('--transport', choices=['stdio', 'http', 'sse'], default='stdio',
-                          help='Transport protocol for the MCP server (default: stdio)')
+        parser.add_argument('--server', action='store_true', help='Start the MCP server')
+        parser.add_argument('--transport', choices=['stdio', 'http', 'sse'], default='stdio', help='Transport protocol for the MCP server (default: stdio)')
         # HTTP/SSE options
         parser.add_argument('--host', type=str, default='127.0.0.1', help='Host to bind for HTTP/SSE transports')
         parser.add_argument('--port', type=int, default=8000, help='Port to bind for HTTP/SSE transports')
         parser.add_argument('--path', type=str, default='/mcp', help='Endpoint path for HTTP/SSE transports')
-        parser.add_argument('--uvicorn-log-level', dest='uvicorn_log_level', type=str, default=None,
-                          help='Log level for the HTTP server (e.g., info, warning, error)')
-        parser.add_argument('--stateless-http', action='store_true', default=None,
-                          help='Use stateless HTTP mode (HTTP transport only)')
-        parser.add_argument('--no-banner', dest='show_banner', action='store_false', default=True,
-                          help='Disable FastMCP startup banner')
+        parser.add_argument('--uvicorn-log-level', dest='uvicorn_log_level', type=str, default=None, help='Log level for the HTTP server (e.g., info, warning, error)')
+        parser.add_argument('--stateless-http', action='store_true', default=None, help='Use stateless HTTP mode (HTTP transport only)')
+        parser.add_argument('--no-banner', dest='show_banner', action='store_false', default=True, help='Disable FastMCP startup banner')
         # Debugging options
         parser.add_argument('--debug', action='store_true', help='Enable debug mode (sets structkit and FastMCP loggers to DEBUG by default)')
-        parser.add_argument('--fastmcp-log-level', dest='fastmcp_log_level', type=str, default=None,
-                          help='Log level for FastMCP internals (e.g., DEBUG, INFO). Overrides --debug for FastMCP if provided')
+        parser.add_argument(
+            '--fastmcp-log-level',
+            dest='fastmcp_log_level',
+            type=str,
+            default=None,
+            help='Log level for FastMCP internals (e.g., DEBUG, INFO). Overrides --debug for FastMCP if provided')
         parser.set_defaults(func=self.execute)
 
     def execute(self, args):
diff --git a/structkit/commands/validate.py b/structkit/commands/validate.py
@@ -1,10 +1,10 @@
-import os
 import yaml
 from dotenv import load_dotenv
 from structkit.commands import Command
 
 load_dotenv()
 
+
 # Validate command class
 class ValidateCommand(Command):
     def __init__(self, parser):
@@ -34,7 +34,6 @@ def execute(self, args):
       self._validate_folders_config(config.get('folders', []))
       self._validate_variables_config(config.get('variables', []))
 
-
     # Validate the 'folders' key in the configuration file
     # folders should be defined as a list of dictionaries
     # each dictionary should have a 'struct' key
@@ -65,7 +64,6 @@ def _validate_folders_config(self, folders):
             if 'with' in content and not isinstance(content['with'], dict):
               raise ValueError(f"The 'with' value for '{name}' must be a dictionary.")
 
-
     # Validate the 'variables' key in the configuration file
     # variables should be defined as a list of dictionaries
     # each dictionary should have a 'name' key and optionall 'default' value
@@ -97,7 +95,6 @@ def _validate_variables_config(self, variables):
             if 'default' in content and content['type'] == 'boolean' and not isinstance(content['default'], bool):
               raise ValueError(f"Invalid default value for '{name}'. Must be a boolean.")
 
-
     def _validate_structure_config(self, structure):
       if not isinstance(structure, list):
         raise ValueError("The 'structure' key must be a list.")
diff --git a/structkit/completers.py b/structkit/completers.py
@@ -1,5 +1,6 @@
 import os
 
+
 class ChoicesCompleter(object):
     def __init__(self, choices):
         self.choices = choices
diff --git a/structkit/content_fetcher.py b/structkit/content_fetcher.py
@@ -21,6 +21,7 @@
 except ImportError:
   gcs_available = False
 
+
 class ContentFetcher:
   def __init__(self, cache_dir=None):
     self.logger = logging.getLogger(__name__)
diff --git a/structkit/file_item.py b/structkit/file_item.py
@@ -1,5 +1,4 @@
 # FILE: file_item.py
-import requests
 import os
 import shutil
 import logging
@@ -11,6 +10,7 @@
 
 load_dotenv()
 
+
 class FileItem:
     def __init__(self, properties):
       self.logger = logging.getLogger(__name__)
@@ -55,7 +55,12 @@ def process_prompt(self, dry_run=False, existing_content=None):
 
         user_prompt = self.user_prompt
         if existing_content:
-          user_prompt += f"\n\nCurrent file content (if any):\n```\n{existing_content}\n```\n\nPlease modify existing content so that it meets the new requirements. Your output should be plain text, without any code blocks or formatting. Do not include any explanations or comments. Just provide the final content of the file."
+          user_prompt += (
+            f"\n\nCurrent file content (if any):\n```\n{existing_content}\n```\n\n"
+            "Please modify existing content so that it meets the new requirements. "
+            "Your output should be plain text, without any code blocks or formatting. "
+            "Do not include any explanations or comments. Just provide the final content of the file."
+          )
 
         self.logger.debug(f"Using system prompt: {system_prompt}")
         self.logger.debug(f"Using user prompt: {user_prompt}")
diff --git a/structkit/filters.py b/structkit/filters.py
diff --git a/structkit/input_store.py b/structkit/input_store.py
diff --git a/structkit/logging_config.py b/structkit/logging_config.py
diff --git a/structkit/main.py b/structkit/main.py
diff --git a/structkit/mcp_server.py b/structkit/mcp_server.py
diff --git a/structkit/model_wrapper.py b/structkit/model_wrapper.py
diff --git a/structkit/template_renderer.py b/structkit/template_renderer.py
diff --git a/structkit/utils.py b/structkit/utils.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[flake8]`
	`2`	`+max-line-length = 200`
	`3`	`+extend-ignore = E111,E114`