code-agent

Name	code-agent JSON
Version	0.2.0.1 JSON
	download
home_page	https://github.com/Gonsix/Code-Agent
Summary	🦾 🤖 ChatGPT-based Agent tool for support your software development.
upload_time	2024-03-06 06:54:43
maintainer	Shingo Morimoto
docs_url	None
author	Shingo Morimoto
requires_python	>=3.9,<4.0
license	MIT
keywords	chatgpt langchain llm ai-tool git
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Code-Agent 🚀
## Use `codex` command to automate software development workflows. ✨
TODO: Update README to v2.0..
Hi👋  I'm Shingo Morimoto, an University student in Japan. I'm so interested in creating LLM application using LangChain. 

The `codex` command,including subcommands: gen-commit, gen-readme, describe, suggest-comment, suggest-code, is a powerful tool to integrate your code with LLM power.✨
Currently, you can execute `codex gen-commit` to automate the creation of Git commit message from diff between HEAD commit and index.

## 🌟 Getting Started



### Install code-agent with pip 📁: 

To use the codex command anywhere install it with pip:

`pip install code-agent` or `pip install --break-system-packages code-agent ` if you are using newer pip. 

### Export OPENAI_API_KEY ⚙️:

You must exoport an `OPENAI_API_KEY` in your environment.
Also, you must have an access to the GPT-4 model to call OpenAI API.

###  **Usage** 🚀:

Amazing! Now you can use `codex` command anywhere!
```
$ codex --help

 Usage: codex [OPTIONS] COMMAND [ARGS]...

╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current shell.                                                                                    │
│ --show-completion             Show completion for the current shell, to copy it or customize the installation.                                             │
│ --help                        Show this message and exit.                                                                                                  │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ describe            [Unimplemented feature]: Describe the source code in files -> codex describe --help                                                    │
│ gen-commit          Generate a commit message from Git diff between HEAD and index.                                                                        │
│ gen-readme          [Unimplemented feature]: Generate Awesome README for your project in interactive way -> codex gen_readme --help                        │
│ say-goodbye                                                                                                                                                │
│ say-hello                                                                                                                                                  │
│ suggest-code        [Unimplemented feature]: Refactor and Suggest code for source code in specified files -> codex suggest_code --help                     │
│ suggest-comment     [Unimplemented feature]: Suggest comment for source code in specified files -> codex suggest_comment --help                            │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

### Generation Result Example🤩:　
`codex gen-commit`
```
    🌟 Implement Rust cat command with line numbering features

    Changes(4):
     🚩 Added command-line parsing   @ src/lib.rs
         Integrated clap library for command-line argument parsing with custom Args struct, supporting file inputs and line numbering options.
     🚩 Implemented file reading functionality   @ src/lib.rs
         Developed file opening and reading capabilities, handling both standard input and file input streams.
     🚩 Implemented line numbering features   @ src/lib.rs
         Added functionality to number lines and number nonblank lines as per command-line arguments.
     🚩 Added main application logic   @ src/main.rs
         Created the main function to parse arguments and execute the application logic, with error handling and process exit on failure.
```
## Dive in! 🌊

With these steps, you're all set to revolutionize your Git commits. May your coding be effortless and your repositories vibrant! 💫

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Gonsix/Code-Agent",
    "name": "code-agent",
    "maintainer": "Shingo Morimoto",
    "docs_url": null,
    "requires_python": ">=3.9,<4.0",
    "maintainer_email": "gonsix3@gmail.com",
    "keywords": "ChatGPT,LangChain,LLM,AI-Tool,Git",
    "author": "Shingo Morimoto",
    "author_email": "gonsix3@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/e8/79/fde055bd824a276208fbd4bce423037fd44b67e60cff53b1439306b9b9ce/code_agent-0.2.0.1.tar.gz",
    "platform": null,
    "description": "# Code-Agent \ud83d\ude80\n## Use `codex` command to automate software development workflows. \u2728\nTODO: Update README to v2.0..\nHi\ud83d\udc4b  I'm Shingo Morimoto, an University student in Japan. I'm so interested in creating LLM application using LangChain. \n\nThe `codex` command,including subcommands: gen-commit, gen-readme, describe, suggest-comment, suggest-code, is a powerful tool to integrate your code with LLM power.\u2728\nCurrently, you can execute `codex gen-commit` to automate the creation of Git commit message from diff between HEAD commit and index.\n\n## \ud83c\udf1f Getting Started\n\n\n\n### Install code-agent with pip \ud83d\udcc1: \n\nTo use the codex command anywhere install it with pip:\n\n`pip install code-agent` or `pip install --break-system-packages code-agent ` if you are using newer pip. \n\n### Export OPENAI_API_KEY \u2699\ufe0f:\n\nYou must exoport an `OPENAI_API_KEY` in your environment.\nAlso, you must have an access to the GPT-4 model to call OpenAI API.\n\n###  **Usage** \ud83d\ude80:\n\nAmazing! Now you can use `codex` command anywhere!\n```\n$ codex --help\n\n Usage: codex [OPTIONS] COMMAND [ARGS]...\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --install-completion          Install completion for the current shell.                                                                                    \u2502\n\u2502 --show-completion             Show completion for the current shell, to copy it or customize the installation.                                             \u2502\n\u2502 --help                        Show this message and exit.                                                                                                  \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 describe            [Unimplemented feature]: Describe the source code in files -> codex describe --help                                                    \u2502\n\u2502 gen-commit          Generate a commit message from Git diff between HEAD and index.                                                                        \u2502\n\u2502 gen-readme          [Unimplemented feature]: Generate Awesome README for your project in interactive way -> codex gen_readme --help                        \u2502\n\u2502 say-goodbye                                                                                                                                                \u2502\n\u2502 say-hello                                                                                                                                                  \u2502\n\u2502 suggest-code        [Unimplemented feature]: Refactor and Suggest code for source code in specified files -> codex suggest_code --help                     \u2502\n\u2502 suggest-comment     [Unimplemented feature]: Suggest comment for source code in specified files -> codex suggest_comment --help                            \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n\n### Generation Result Example\ud83e\udd29:\u3000\n`codex gen-commit`\n```\n    \ud83c\udf1f Implement Rust cat command with line numbering features\n\n    Changes(4):\n     \ud83d\udea9 Added command-line parsing   @ src/lib.rs\n         Integrated clap library for command-line argument parsing with custom Args struct, supporting file inputs and line numbering options.\n     \ud83d\udea9 Implemented file reading functionality   @ src/lib.rs\n         Developed file opening and reading capabilities, handling both standard input and file input streams.\n     \ud83d\udea9 Implemented line numbering features   @ src/lib.rs\n         Added functionality to number lines and number nonblank lines as per command-line arguments.\n     \ud83d\udea9 Added main application logic   @ src/main.rs\n         Created the main function to parse arguments and execute the application logic, with error handling and process exit on failure.\n```\n## Dive in! \ud83c\udf0a\n\nWith these steps, you're all set to revolutionize your Git commits. May your coding be effortless and your repositories vibrant! \ud83d\udcab\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "\ud83e\uddbe \ud83e\udd16 ChatGPT-based Agent tool for support your software development.",
    "version": "0.2.0.1",
    "project_urls": {
        "Homepage": "https://github.com/Gonsix/Code-Agent",
        "Repository": "https://github.com/Gonsix/Code-Agent"
    },
    "split_keywords": [
        "chatgpt",
        "langchain",
        "llm",
        "ai-tool",
        "git"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8452a4b876d7c4d2361a978378191e0d28d07d5bf3651faec189e91f5cd4ea23",
                "md5": "f3c45f953c3bba5f3bf84f1f47267d33",
                "sha256": "eb6cfbdf212f06d3ea7d5135eb043fd504497bf170c38d6ef631aa3a80068151"
            },
            "downloads": -1,
            "filename": "code_agent-0.2.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f3c45f953c3bba5f3bf84f1f47267d33",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<4.0",
            "size": 13049,
            "upload_time": "2024-03-06T06:54:41",
            "upload_time_iso_8601": "2024-03-06T06:54:41.605804Z",
            "url": "https://files.pythonhosted.org/packages/84/52/a4b876d7c4d2361a978378191e0d28d07d5bf3651faec189e91f5cd4ea23/code_agent-0.2.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e879fde055bd824a276208fbd4bce423037fd44b67e60cff53b1439306b9b9ce",
                "md5": "d556be6db073e571a7e13d4dcef3c327",
                "sha256": "6c50481c28f59fc528c50665a84435d9573e2dbf7691edf281725b2405b15cb6"
            },
            "downloads": -1,
            "filename": "code_agent-0.2.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d556be6db073e571a7e13d4dcef3c327",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<4.0",
            "size": 9672,
            "upload_time": "2024-03-06T06:54:43",
            "upload_time_iso_8601": "2024-03-06T06:54:43.330946Z",
            "url": "https://files.pythonhosted.org/packages/e8/79/fde055bd824a276208fbd4bce423037fd44b67e60cff53b1439306b9b9ce/code_agent-0.2.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-06 06:54:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Gonsix",
    "github_project": "Code-Agent",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "code-agent"
}

Shingo Morimoto