structkit 3.0.0__py3-none-any.whl

structkit/contribs/cloudformation-files.yaml

@@ -0,0 +1,21 @@
+files:
+  - template.yaml:
+      content: |
+        Resources:
+          ExampleBucket:
+            Type: AWS::S3::Bucket
+            Properties:
+              BucketName: example-bucket
+  - parameters.json:
+      content: |
+        [
+          {
+            "ParameterKey": "BucketName",
+            "ParameterValue": "example-bucket"
+          }
+        ]
+  - deploy.sh:
+      permissions: 755
+      content: |
+        #!/bin/bash
+        aws cloudformation deploy --stack-name example-stack --template-file template.yaml --parameter-overrides $(cat parameters.json | jq -r '.[] | "--parameters \(.ParameterKey)=\(.ParameterValue)"') --capabilities CAPABILITY_IAM

structkit/contribs/configs/chglog.yaml

@@ -0,0 +1,31 @@
+files:
+  - .chglog/config.yaml:
+      content: |
+        style: github
+        template: CHANGELOG.tpl.md
+        info:
+          title: CHANGELOG
+          repository_url: https://github.com/uridium/terraform-aws-ec2-connect-endpoint
+        options:
+          header:
+            pattern: "^((\\w+)\\s.*)$"
+            pattern_maps:
+              - Subject
+  - .chglog/CHANGELOG.tpl.md:
+      content: |
+        # CHANGELOG
+        {{ range .Versions }}
+        <a name="{{ .Tag.Name }}"></a>
+        ## {{ if .Tag.Previous }}[{{ .Tag.Name }}]({{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}){{ else }}{{ .Tag.Name }}{{ end }} ({{ datetime "2006-01-02" .Tag.Date }})
+        {{ range .Commits -}}
+        {{- if not (hasPrefix .Subject "Merge pull") -}}
+        {{- if not (contains .Subject "README") -}}
+        {{- if not (hasSuffix .Subject "[ci skip]") -}}
+        {{- if not (hasSuffix .Subject "[skip ci]") -}}
+        * {{ .Subject }}
+        {{ end -}}
+        {{ end -}}
+        {{ end -}}
+        {{ end -}}
+        {{ end -}}
+        {{ end -}}

structkit/contribs/configs/codeowners.yaml

@@ -0,0 +1,3 @@
+files:
+  - CODEOWNERS: |
+      * @github_username

structkit/contribs/configs/devcontainer.yaml

@@ -0,0 +1,35 @@
+files:
+  - .devcontainer/devcontainer.json:
+      content: |
+        // For format details, see https://aka.ms/devcontainer.json. For config options, see the
+        // README at: https://github.com/devcontainers/templates/tree/main/src/python
+        {
+          "name": "Python 3",
+          // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+          "image": "mcr.microsoft.com/devcontainers/python:1-3.12-bullseye",
+          "features": {
+            "ghcr.io/devcontainers/features/python:1": {
+              "installTools": true,
+              "version": "latest"
+            },
+            "ghcr.io/lentzi90/features/yamlfmt:0": {
+              "version": "v0.14.0"
+            },
+            "ghcr.io/gvatsal60/dev-container-features/pre-commit:1": {}
+          }
+
+          // Features to add to the dev container. More info: https://containers.dev/features.
+          // "features": {},
+
+          // Use 'forwardPorts' to make a list of ports inside the container available locally.
+          // "forwardPorts": [],
+
+          // Use 'postCreateCommand' to run commands after the container is created.
+          // "postCreateCommand": "pip3 install --user -r requirements.txt",
+
+          // Configure tool-specific properties.
+          // "customizations": {},
+
+          // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+          // "remoteUser": "root"
+        }

structkit/contribs/configs/editor-config.yaml

@@ -0,0 +1,11 @@
+files:
+  - .editorconfig:
+      content: |
+        root = true
+        [*]
+        charset = utf-8
+        end_of_line = lf
+        insert_final_newline = true
+        indent_style = space
+        indent_size = 2
+        trim_trailing_whitespace = true

structkit/contribs/configs/eslint.yaml

@@ -0,0 +1,30 @@
+files:
+  - .eslintrc.json:
+      content: |
+        {
+          "env": {
+            "browser": true,
+            "es2021": true
+          },
+          "extends": [
+            "eslint:recommended",
+            "plugin:react/recommended"
+          ],
+          "parserOptions": {
+            "ecmaFeatures": {
+              "jsx": true
+            },
+            "ecmaVersion": 12,
+            "sourceType": "module"
+          },
+          "plugins": [
+            "react"
+          ],
+          "rules": {
+            "react/prop-types": "off"
+          }
+        }
+  - .eslintignore:
+      content: |
+        node_modules/
+        dist/

structkit/contribs/configs/jshint.yaml

@@ -0,0 +1,11 @@
+files:
+  - .jshintrc:
+      content: |
+        {
+          "node": true,
+          "esversion": 6
+        }
+  - .jshintignore:
+      content: |
+        node_modules/
+        dist/

structkit/contribs/configs/kubectl.yaml

@@ -0,0 +1,23 @@
+files:
+  - .kuberc:
+      content: |
+        apiVersion: kubectl.config.k8s.io/v1alpha1
+        kind: Preference
+        # alias "kubectl crns" for "kubectl create namespace {{@ namespace @}}"
+        aliases:
+          - name: crns
+            command: create namespace
+            appendArgs:
+              - {{@ namespace @}}
+        # Force the --interactive=true flag for kubectl delete
+        overrides:
+          - command: delete
+            flags:
+              - name: interactive
+                default: "true"
+
+variables:
+  - namespace:
+      description: The name of the namespace to create.
+      type: string
+      default: default

structkit/contribs/configs/prettier.yaml

@@ -0,0 +1,19 @@
+files:
+  - .prettierrc:
+      content: |
+        {
+          "semi": true,
+          "trailingComma": "es5",
+          "singleQuote": true,
+          "endOfLine": "lf",
+          "tabWidth": 2,
+          "arrowParens": "always",
+          "printWidth": 80,
+          "bracketSpacing": true,
+          "quoteProps": "as-needed",
+          "proseWrap": "preserve"
+        }
+  - .prettierignore:
+      content: |
+        node_modules/
+        dist/

structkit/contribs/docker-files.yaml

@@ -0,0 +1,27 @@
+files:
+  - Dockerfile:
+      content: |
+        FROM nginx:latest
+        COPY index.html /usr/share/nginx/html/index.html
+  - .dockerignore:
+      content: |
+        .git
+        .idea
+        .vscode
+  - docker-compose.yml:
+      content: |
+        version: '3'
+        services:
+          web:
+            build: .
+            env_file:
+              - .env
+            ports:
+              - "80:80"
+          db:
+            image: mysql:latest
+            environment:
+              MYSQL_ROOT_PASSWORD: example
+  - .env:
+      content: |
+        MYSQL_ROOT_PASSWORD=example

structkit/contribs/documentation-template.yaml

@@ -0,0 +1,33 @@
+files:
+  - README.md:
+      content: |
+        # {{@ project_name @}}
+
+        Brief description of the project.
+
+        ## Installation
+
+        Steps to install the project.
+
+        ## Usage
+
+        Instructions to use the project.
+
+        ## Contributing
+
+        Guidelines for contributing to the project.
+  - CONTRIBUTING.md:
+      content: |
+        # Contributing to {{@ project_name @}}
+
+        ## How to Contribute
+        Guidelines for how to contribute to the project.
+
+        ## Code of Conduct
+        Code of conduct for contributors.
+  - CODE_OF_CONDUCT.md:
+      content: |
+        # Code of Conduct
+        Our standards for how to behave within our community.
+  - LICENSE.md:
+      file: https://raw.githubusercontent.com/git/git-scm.com/main/MIT-LICENSE.txt

structkit/contribs/git-hooks.yaml

@@ -0,0 +1,19 @@
+files:
+  - .git/hooks/pre-commit:
+      permissions: 755
+      content: |
+        #!/bin/sh
+        echo "Running pre-commit hook"
+        # Add pre-commit tasks here
+  - .git/hooks/pre-push:
+      permissions: 755
+      content: |
+        #!/bin/sh
+        echo "Running pre-push hook"
+        # Add pre-push tasks here
+  - .git/hooks/commit-msg:
+      permissions: 755
+      content: |
+        #!/bin/sh
+        echo "Running commit-msg hook"
+        # Add commit-msg tasks here

structkit/contribs/github/chatmodes/plan.yaml

@@ -0,0 +1,18 @@
+files:
+  - ./github/chatmodes/plan.chatmode.md:
+      content: |
+        ---
+        description: Generate an implementation plan for new features or refactoring existing code.
+        tools: ['codebase', 'fetch', 'findTestFiles', 'githubRepo', 'search', 'usages']
+        model: Claude Sonnet 4
+        ---
+        # Planning mode instructions
+        You are in planning mode. Your task is to generate an implementation plan for a new feature or for refactoring existing code.
+        Don't make any code edits, just generate a plan.
+
+        The plan consists of a Markdown document that describes the implementation plan, including the following sections:
+
+        * Overview: A brief description of the feature or refactoring task.
+        * Requirements: A list of requirements for the feature or refactoring task.
+        * Implementation Steps: A detailed list of steps to implement the feature or refactoring task.
+        * Testing: A list of tests that need to be implemented to verify the feature or refactoring task.

structkit/contribs/github/instructions/generic.yaml

@@ -0,0 +1,5 @@
+files:
+  - .github/instructions/generic.instruction.md:
+      skip_if_exists: true
+      content: |
+        Your instructions here

structkit/contribs/github/prompts/generic.yaml

@@ -0,0 +1,4 @@
+files:
+  - .github/prompts/generic.prompt.md:
+      content: |
+        Your prompt here

structkit/contribs/github/prompts/react-form.yaml

@@ -0,0 +1,17 @@
+files:
+  - .github/prompts/react-form.prompt.md:
+      content: |
+        Your goal is to generate a new React form component.
+
+        Ask for the form name and fields if not provided.
+
+        Requirements for the form:
+        * Use form design system components: [design-system/Form.md](../docs/design-system/Form.md)
+        * Use `react-hook-form` for form state management:
+        * Always define TypeScript types for your form data
+        * Prefer *uncontrolled* components using register
+        * Use `defaultValues` to prevent unnecessary rerenders
+        * Use `yup` for validation:
+        * Create reusable validation schemas in separate files
+        * Use TypeScript types to ensure type safety
+        * Customize UX-friendly validation rules

structkit/contribs/github/prompts/security-api.yaml

@@ -0,0 +1,8 @@
+files:
+  - .github/prompts/security-api.prompt.md:
+      content: |
+        Secure REST API review:
+        * Ensure all endpoints are protected by authentication and authorization
+        * Validate all user inputs and sanitize data
+        * Implement rate limiting and throttling
+        * Implement logging and monitoring for security events

structkit/contribs/github/prompts/struct.yaml

@@ -0,0 +1,90 @@
+files:
+  - .github/prompts/struct.prompt.md:
+      content: |
+        # StructKit Assistant
+
+        ## Role
+
+        You are an expert assistant that generates valid `.struct.yaml` files for the [StructKit tool](https://github.com/httpdss/struct), which automates project structure generation from YAML configuration.
+
+        ## Defining the `.struct.yaml` file
+
+        this file has 3 main keys: `structures`, `folders`, and `variables`.
+
+        ### Defining structures
+
+        The `structures` key is used to define files that are created. Each file path should have a reference to the content it needs to put on the file or the content of the file itself.
+        For referencing the content of a file, you can use the `file:` key with the path to the file. this can also be a remote https file.
+        The content of the file can be defined using the `content:` key with a pipe notation (`|`) for multiline content.
+
+        ```yaml
+        structures:
+          - path/to/file.txt:
+              content: |
+                This is the content of the file.
+          - path/to/remote/file.txt:
+              file: https://example.com/file.txt
+        ```
+
+        ### Defining folders
+
+        The `folders` key is used to define folders that are created. Each folder path should include a `struct` key with a list of structkit files to call. Optionally, you can define the value of a variable using the `with:` key.
+        The list of structkit files available can be taken from all the files defined inside `structkit/contribs/`.
+        Remember the name of the structkit file is the path to the file without the `.yaml` extension.
+        Read from the structkit file to kown the variables that can be used.
+
+        ```yaml
+        folders:
+          - ./path/to/folder/:
+              struct:
+                - terraform/module
+              with:
+                variable_name: value
+          - ./:
+              struct:
+                - github/prompts/struct
+        ```
+
+        ### Defining variables
+
+        The `variables` key is used to define variables that can be used in the structkit files. Each variable should have a description, type, and optional default value.
+
+        ```yaml
+        variables:
+          - variable_name:
+              description: Description of the variable
+              type: string
+              default: default_value
+        ```
+
+        ## Important notes
+
+        - Follow the JSON Schema definition provided in the references.
+        - Use valid keys: `structures`, `folders`, and `variables`.
+        - if you want to define files, use the `structures:` key, and a list of file paths that are created. each file path should have a content key.
+        - if you want to define folders, use the `folders:` key, and a list of folder paths that are created. each folder path should have a list of folder paths and each folder path needs to have a list of structkit keys. also if you want to define the value of a variable then you should use the `with:` key.
+        - Follow the conventions from the StructKit README provided in the references.
+        - Include content blocks under `content:` using pipe notation (`|`) when needed.
+        - Use `permissions`, `skip`, or `skip_if_exists` if specified. This is used only for the `structures` key.
+        - Use `file:` to reference the content of a file or `content:` to define the content of the file.
+        - Use `struct:` to define the list of structkit files to call for a folder.
+        - Optionally, use Jinja2 custom filters such as `| latest_release`, `| default_branch`, or `| slugify`.
+
+        ## Output
+
+        Only output the YAML content, no explanation or prose.
+
+        ## Example usage
+
+        - Create a project template for a Python CLI tool
+        - Generate a Terraform module with `terraform/module` sub-struct
+        - Using interactive variables for author/project name
+
+        If unsure of a value, use sensible defaults or define a variable.
+
+        Always return YAML that is syntactically correct and validated against the provided schema.
+
+        ## References
+
+        - [StructKit json schema](https://raw.githubusercontent.com/httpdss/structkit/refs/heads/main/struct-schema.json)
+        - [StructKit README](https://raw.githubusercontent.com/httpdss/structkit/refs/heads/main/README.md)

structkit/contribs/github/templates.yaml

@@ -0,0 +1,91 @@
+files:
+  - .github/PULL_REQUEST_TEMPLATE/bug_fix_template.md:
+      content: |
+        ## Bug Fix
+        ### Description
+        <!--- A clear and concise description of what the bug is. -->
+        ### Steps to Reproduce
+        <!--- Steps to reproduce the behavior: -->
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+        ### Expected Behavior
+        <!--- A clear and concise description of what you expected to happen. -->
+        ### Screenshots
+        <!--- If applicable, add screenshots to help explain your problem. -->
+        ### Additional context
+        <!--- Add any other context about the problem here. -->
+  - .github/PULL_REQUEST_TEMPLATE/feature_request_template.md:
+      content: |
+        ## Feature Request
+        ### Description
+        <!--- A clear and concise description of what the problem is. Ex. I'm always frustrated when [..
+        ### Solution
+        <!--- A clear and concise description of what you want to happen. -->
+        ### Alternatives
+        <!--- A clear and concise description of any alternative solutions or features you've considered. -->
+        ### Screenshots
+        <!--- If applicable, add screenshots to help explain your problem. -->
+        ### Additional context
+        <!--- Add any other context or screenshots about the feature request here. -->
+  - .github/PULL_REQUEST_TEMPLATE/pull_request_template.md:
+      content: |
+        # Description
+
+        Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+        Fixes # (issue)
+
+        ## Type of change
+
+        Please delete options that are not relevant.
+
+        - [ ] Bug fix (non-breaking change which fixes an issue)
+        - [ ] New feature (non-breaking change which adds functionality)
+        - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+        - [ ] This change requires a documentation update
+
+        # How Has This Been Tested?
+
+        Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+
+        - [ ] Test A
+        - [ ] Test B
+
+        **Test Configuration**:
+        * Firmware version:
+        * Hardware:
+        * Toolchain:
+        * SDK:
+
+        # Checklist:
+
+        - [ ] My code follows the style guidelines of this project
+        - [ ] I have performed a self-review of my code
+        - [ ] I have commented my code, particularly in hard-to-understand areas
+        - [ ] I have made corresponding changes to the documentation
+        - [ ] My changes generate no new warnings
+        - [ ] I have added tests that prove my fix is effective or that my feature works
+        - [ ] New and existing unit tests pass locally with my changes
+        - [ ] Any dependent changes have been merged and published in downstream modules
+  - .github/ISSUE_TEMPLATE/issue_template.md:
+      content: |
+        ## I'm submitting a ...
+
+        - [ ] bug report
+        - [ ] feature request
+
+        ## What is the current behavior?
+
+        ## If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem
+
+        ## What is the expected behavior?
+
+        ## What is the motivation / use case for changing the behavior?
+
+        ## Please tell us about your environment:
+
+        Version: 2.0.0-beta.X
+        Browser:
+        Language:

structkit/contribs/github/workflows/codeql.yaml

@@ -0,0 +1,88 @@
+files:
+  - .github/workflows/z-codeql.yaml:
+      content: | # yaml
+        # For most projects, this workflow file will not need changing; you simply need
+        # to commit it to your repository.
+        #
+        # You may wish to alter this file to override the set of languages analyzed,
+        # or to provide custom queries or build logic.
+        #
+        # ******** NOTE ********
+        # We have attempted to detect the languages in your repository. Please check
+        # the `language` matrix defined below to confirm you have the correct set of
+        # supported CodeQL languages.
+        #
+        name: 'CodeQL'
+
+        on:
+          push:
+            branches: ['develop', 'master', 'release**']
+            # paths-ignore:
+            #   - '**/__mockData__'
+          pull_request:
+            # The branches below must be a subset of the branches above
+            branches: ['develop', 'release**']
+            # paths-ignore:
+            #   - '**/__mockData__'
+          schedule:
+            - cron: '42 10 * * 1'
+
+        jobs:
+          analyze:
+            name: Analyze
+            # Runner size impacts CodeQL analysis time. To learn more, please see:
+            #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+            #   - https://gh.io/supported-runners-and-hardware-resources
+            #   - https://gh.io/using-larger-runners
+            # Consider using larger runners for possible analysis time improvements.
+            runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+            timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
+            permissions:
+              actions: read
+              contents: read
+              security-events: write
+
+            strategy:
+              fail-fast: false
+              matrix:
+                language: ['javascript']
+                # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby', 'swift' ]
+                # Use only 'java' to analyze code written in Java, Kotlin or both
+                # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+                # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+            steps:
+              - name: Checkout repository
+                uses: actions/checkout@{{@ "actions/checkout" | latest_release @}}
+
+              # Initializes the CodeQL tools for scanning.
+              - name: Initialize CodeQL
+                uses: github/codeql-action/init@{{@ "github/codeql-action" | latest_release @}}
+                with:
+                  languages: ${{ matrix.language }}
+                  # If you wish to specify custom queries, you can do so here or in a config file.
+                  # By default, queries listed here will override any specified in a config file.
+                  # Prefix the list here with '+' to use these queries and those in the config file.
+
+                  # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+                  # queries: security-extended,security-and-quality
+
+              # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
+              # If this step fails, then you should remove it and run the build manually (see below)
+              - name: Autobuild
+                uses: github/codeql-action/autobuild@{{@ "github/codeql-action" | latest_release @}}
+
+              # ℹ️ Command-line programs to run using the OS shell.
+              # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+              #   If the Autobuild fails above, remove it and uncomment the following three lines.
+              #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+              # - run: |
+              #     echo 'Run, Build Application using script'
+              #     ./location_of_script_within_repo/buildscript.sh
+
+              - name: Perform CodeQL Analysis
+                uses: github/codeql-action/analyze@{{@ "github/codeql-action" | latest_release @}}
+                with:
+                  category: '/language:${{matrix.language}}'

structkit/contribs/github/workflows/execute-tf-workflow.yaml

@@ -0,0 +1,39 @@
+files:
+  - .github/workflows/execute-tf-{{@ app_name | slugify @}}.yaml:
+      content: |
+        name: 'execute-tf-{{@ app_name | slugify @}}'
+        on:
+          pull_request:
+            branches:
+              - main
+            paths:
+              - '.devops/apps/**'
+              - '.github/workflows/execute-tf-{{@ app_name | slugify @}}.yaml'
+          push:
+            branches:
+              - main
+            paths:
+              - '.devops/apps/**'
+              - '.github/workflows/execute-tf-{{@ app_name | slugify @}}.yaml'
+
+        jobs:
+          tf-workflow:
+            uses: httpdss/github-workflows/.github/workflows/execute-tf-workflow.yaml@main
+            with:
+              working-directory: '.devops/apps/{{@ app_path @}}'
+            secrets:
+              gh-token: {{@ github_token @}}
+
+variables:
+  - app_name:
+      description: "The name of the app."
+      default: "environments-dev"
+      type: string
+  - app_path:
+      description: "The working directory for the terraform workflow."
+      default: "environments/dev"
+      type: string
+  - github_token:
+      description: "The GitHub token for authentication."
+      default: "${{ secrets.GITHUB_TOKEN }}"
+      type: string