kilu


Namekilu JSON
Version 1.1 PyPI version JSON
download
home_pagehttps://github.com/buanzo/kilu
SummaryKilu: A YAML-based template system for generating project files
upload_time2023-04-14 11:11:58
maintainer
docs_urlNone
authorArturo "Buanzo" Busleiman
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Kilu

Kilu is a YAML-based template system that allows you to generate project files for any type of project you indicate. With a simple and flexible syntax, Kilu makes it easy to define and manage project structures.

## Introduction

Kilu uses YAML to define project templates, which include the base directory for the project, as well as a list of file entries. Each file entry specifies the file's name and content. Kilu also supports Base64 encoding for binary file contents, allowing you to work with a wide range of file types.

## Examples

### Basic Kilu Template

```yaml
basedir: "your_project_directory"

files:
  - name: "file_name_1.ext"
    content: |
      This is the content of file_name_1.ext.

  - name: "file_name_2.ext"
    content: |
      This is the content of file_name_2.ext.
```

### Kilu Template with base64 encoded Binary file content

```yaml
basedir: "my_project_with_binary_files"

files:
  - name: "example.gif"
    content_base64: |
      R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7

  - name: "example.zip"
    content_base64: |
      UEsFBgAAAAAAAAAAAAAAAAAAAAAAAA==
```

## Examples of GPT generating Kilu templates for the user

In this section, we showcase how GPT can generate Kilu templates for users based on their requests. By leveraging GPT's natural language understanding capabilities, the model can create context-aware and relevant project templates.
These examples demonstrate how GPT can generate Kilu templates based on user requests, creating custom project structures that fit the user's specific needs.

### Example 1: Simple Python Project

**User request:** "Create a Kilu template for a simple Python project with a `main.py` file that prints 'Hello, World!'."

**GPT-generated Kilu template:**

```yaml
basedir: "simple_python_project"

files:
  - name: "main.py"
    content: |
      def main():
          print("Hello, World!")
          
      if __name__ == "__main__":
          main()


### Example 2: Basic HTML and CSS Project

User request: "Generate a Kilu template for a basic HTML and CSS project with an index.html file and a styles.css file."

GPT-generated Kilu template:

```yaml
basedir: "basic_html_css_project"

files:
  - name: "index.html"
    content: |
      <!DOCTYPE html>
      <html lang="en">
      <head>
          <meta charset="UTF-8">
          <meta name="viewport" content="width=device-width, initial-scale=1.0">
          <link rel="stylesheet" href="styles.css">
          <title>Basic HTML and CSS Project</title>
      </head>
      <body>
          <h1>Welcome to the Basic HTML and CSS Project!</h1>
      </body>
      </html>

  - name: "styles.css"
    content: |
      body {
          font-family: Arial, sans-serif;
          background-color: #f0f0f0;
      }

      h1 {
          color: #333;
      }
```


## Why Use Kilu with GPT

Kilu can be a powerful tool when combined with the Generative Pre-trained Transformer (GPT) models like OpenAI's GPT-3 or GPT-4. By using Kilu templates as input (or ask GPT to output Kilu...) for GPT, you can:

1. Generate custom code snippets or configurations for different programming languages and frameworks.
2. Automate the creation of project files or folder structures based on user input or other criteria.
3. Leverage GPT's natural language understanding capabilities to generate more context-aware and relevant project files.
4. Summarize, Analyze third-party Kilu templates for security issues, functionality, or easily update an entire project dynamically.

The combination of Kilu's simplicity and GPT's advanced language modeling capabilities opens up a world of possibilities for creating dynamic and intelligent project templates that adapt to your specific needs.

## About the Author

Arturo "Buanzo" Busleiman is the creator of Kilu. With extensive experience in the software development and technology industry, Buanzo has a passion for creating tools that simplify and streamline the development process, empowering developers to focus on building great projects.

Visit [github.com/buanzo](https://github.com/buanzo) to see more of Buanzo's work.


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/buanzo/kilu",
    "name": "kilu",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Arturo \"Buanzo\" Busleiman",
    "author_email": "buanzo@buanzo.com.ar",
    "download_url": "https://files.pythonhosted.org/packages/18/ca/06f80fb86ffd3eb40631db75513dbc70ff1da168f37749f5dcd5de603938/kilu-1.1.tar.gz",
    "platform": null,
    "description": "# Kilu\n\nKilu is a YAML-based template system that allows you to generate project files for any type of project you indicate. With a simple and flexible syntax, Kilu makes it easy to define and manage project structures.\n\n## Introduction\n\nKilu uses YAML to define project templates, which include the base directory for the project, as well as a list of file entries. Each file entry specifies the file's name and content. Kilu also supports Base64 encoding for binary file contents, allowing you to work with a wide range of file types.\n\n## Examples\n\n### Basic Kilu Template\n\n```yaml\nbasedir: \"your_project_directory\"\n\nfiles:\n  - name: \"file_name_1.ext\"\n    content: |\n      This is the content of file_name_1.ext.\n\n  - name: \"file_name_2.ext\"\n    content: |\n      This is the content of file_name_2.ext.\n```\n\n### Kilu Template with base64 encoded Binary file content\n\n```yaml\nbasedir: \"my_project_with_binary_files\"\n\nfiles:\n  - name: \"example.gif\"\n    content_base64: |\n      R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7\n\n  - name: \"example.zip\"\n    content_base64: |\n      UEsFBgAAAAAAAAAAAAAAAAAAAAAAAA==\n```\n\n## Examples of GPT generating Kilu templates for the user\n\nIn this section, we showcase how GPT can generate Kilu templates for users based on their requests. By leveraging GPT's natural language understanding capabilities, the model can create context-aware and relevant project templates.\nThese examples demonstrate how GPT can generate Kilu templates based on user requests, creating custom project structures that fit the user's specific needs.\n\n### Example 1: Simple Python Project\n\n**User request:** \"Create a Kilu template for a simple Python project with a `main.py` file that prints 'Hello, World!'.\"\n\n**GPT-generated Kilu template:**\n\n```yaml\nbasedir: \"simple_python_project\"\n\nfiles:\n  - name: \"main.py\"\n    content: |\n      def main():\n          print(\"Hello, World!\")\n          \n      if __name__ == \"__main__\":\n          main()\n\n\n### Example 2: Basic HTML and CSS Project\n\nUser request: \"Generate a Kilu template for a basic HTML and CSS project with an index.html file and a styles.css file.\"\n\nGPT-generated Kilu template:\n\n```yaml\nbasedir: \"basic_html_css_project\"\n\nfiles:\n  - name: \"index.html\"\n    content: |\n      <!DOCTYPE html>\n      <html lang=\"en\">\n      <head>\n          <meta charset=\"UTF-8\">\n          <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n          <link rel=\"stylesheet\" href=\"styles.css\">\n          <title>Basic HTML and CSS Project</title>\n      </head>\n      <body>\n          <h1>Welcome to the Basic HTML and CSS Project!</h1>\n      </body>\n      </html>\n\n  - name: \"styles.css\"\n    content: |\n      body {\n          font-family: Arial, sans-serif;\n          background-color: #f0f0f0;\n      }\n\n      h1 {\n          color: #333;\n      }\n```\n\n\n## Why Use Kilu with GPT\n\nKilu can be a powerful tool when combined with the Generative Pre-trained Transformer (GPT) models like OpenAI's GPT-3 or GPT-4. By using Kilu templates as input (or ask GPT to output Kilu...) for GPT, you can:\n\n1. Generate custom code snippets or configurations for different programming languages and frameworks.\n2. Automate the creation of project files or folder structures based on user input or other criteria.\n3. Leverage GPT's natural language understanding capabilities to generate more context-aware and relevant project files.\n4. Summarize, Analyze third-party Kilu templates for security issues, functionality, or easily update an entire project dynamically.\n\nThe combination of Kilu's simplicity and GPT's advanced language modeling capabilities opens up a world of possibilities for creating dynamic and intelligent project templates that adapt to your specific needs.\n\n## About the Author\n\nArturo \"Buanzo\" Busleiman is the creator of Kilu. With extensive experience in the software development and technology industry, Buanzo has a passion for creating tools that simplify and streamline the development process, empowering developers to focus on building great projects.\n\nVisit [github.com/buanzo](https://github.com/buanzo) to see more of Buanzo's work.\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Kilu: A YAML-based template system for generating project files",
    "version": "1.1",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1bd1398d5a61520bc254796271ef51eec5ce4fc47e971672f6f7ecd8ada8c205",
                "md5": "3290437b5bacc1c4cd5b9d32ef72f279",
                "sha256": "dbd88f54d997b9f59ffa3ea9ff0dfa4ebef58c5dc3d27e3840d2321578e12981"
            },
            "downloads": -1,
            "filename": "kilu-1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3290437b5bacc1c4cd5b9d32ef72f279",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5440,
            "upload_time": "2023-04-14T11:11:56",
            "upload_time_iso_8601": "2023-04-14T11:11:56.363137Z",
            "url": "https://files.pythonhosted.org/packages/1b/d1/398d5a61520bc254796271ef51eec5ce4fc47e971672f6f7ecd8ada8c205/kilu-1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "18ca06f80fb86ffd3eb40631db75513dbc70ff1da168f37749f5dcd5de603938",
                "md5": "9ced8d2e49e803de60c4972d33ae01f7",
                "sha256": "0da6c183b24114376888109eadffd46934c11f268748fdc3070dc7e7a987d476"
            },
            "downloads": -1,
            "filename": "kilu-1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "9ced8d2e49e803de60c4972d33ae01f7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4877,
            "upload_time": "2023-04-14T11:11:58",
            "upload_time_iso_8601": "2023-04-14T11:11:58.254474Z",
            "url": "https://files.pythonhosted.org/packages/18/ca/06f80fb86ffd3eb40631db75513dbc70ff1da168f37749f5dcd5de603938/kilu-1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-04-14 11:11:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "buanzo",
    "github_project": "kilu",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "kilu"
}
        
Elapsed time: 0.06174s