python-coding-assistant


Namepython-coding-assistant JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/yourusername/python-coding-assistant
SummaryA coding assistant for Python developers
upload_time2023-06-03 22:39:13
maintainer
docs_urlNone
authorYour Name
requires_python>=3.6
licenseMIT
keywords coding assistant
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ## ✨ Coding Assistant ✨


This project aims to develop a usable coding agent, which will work iteratively in collaboration with a developer.

At the current time, BabyAgi/AutoGPT approaches are too unstable to be of very much assistance. However, there is every reason to develop an agent that learns from its environment, from its mistakes (Reflexion), and from your chat history, and develops tools as needed (Voyager).

# Usage

You can install this from [PyPi](https://pypi.org/project/voyager-dev/) with `pip install voyager_dev`.

Alternatively, you can clone this repository. Then to install this repository as a global Python CLI tool, run `pip install -e .`

Either way, you should also put your OpenAI and Google Search API keys in your .bashrc or .zshrc file, like this:

```
export OPENAI_API_KEY=yourkeyhere
export GOOGLE_API_KEY=yourkeyhere
export GOOGLE_CSE_ID=yourkeyhere
```

You can get the latter two by creating the GOOGLE_API_KEY in the [Google Cloud credential console](https://console.cloud.google.com/apis/credentials) and a GOOGLE_CSE_ID using the [Programmable Search Engine](https://programmablesearchengine.google.com/controlpanel/create). Examine the output carefully the first time you run it, Google may return a detailed error telling you how to fix it.

After that, you can simply type `voyager_dev` anywhere on the command line.

# Contributions and Issues

PRs are very welcome! See the development roadmap below for ideas. You can open an issue here, but be sure to include helpful environmental information. I am unlikely to be of assistance for Windows issues, beyond advising you to move to OSX/*nix.

# Development Roadmap

- [x] Fix the terminal tool bug
- [x] Get agent to ask for task. Maybe use prefix
- [x] Install as command-line tool
- [x] Install to PyPi (using the agent itself!)
- [ ] On initialization, ask which files to embed
- [ ] Add project structure and current location to every request
- Agent does not always get input
- Add persistent chat history per directory.
- Only send up to maximum tokens. Use embeddings (or split with most recent). It crashes if terminal output is too long.
- Add logging capabilities so we can see running terminal commands in a separate terminal with tail -f /path/to/logfile
-- Also useful for sub-agents
- Allow it to interrupt execution for subprocesses that ask for user input it does not have.
- [Voyager](https://github.com/MineDojo/Voyager/tree/main/voyager) approach, build up skills list
- Add a separate memory store for [Reflexion](https://github.com/noahshinn024/reflexion)
- Maybe switch to Chroma for embeddings
- Maybe use qlora to implement Toolformer. Can reflexion/Voyager provide training data?
- Enable local LLM, a la GPT4All

# Safety

Currently the shell/terminal command is the most unsafe tool given to this agent. While the prompt includes instructions to limit the damage, this is not an adequate substitute for actual safeguards.

Enhance with:
- Local LLM
- Programmatic (not LLM) confirmation, or sandboxed LLM confirmation
- Crypto signing tool for certain tasks

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/yourusername/python-coding-assistant",
    "name": "python-coding-assistant",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "coding assistant",
    "author": "Your Name",
    "author_email": "your.email@example.com",
    "download_url": "https://files.pythonhosted.org/packages/c8/7c/4c94f741e03842003d8fa58f9c8ba10a11091e892ea55356b0cc3702efb1/python-coding-assistant-0.1.0.tar.gz",
    "platform": null,
    "description": "## \u2728 Coding Assistant \u2728\n\n\nThis project aims to develop a usable coding agent, which will work iteratively in collaboration with a developer.\n\nAt the current time, BabyAgi/AutoGPT approaches are too unstable to be of very much assistance. However, there is every reason to develop an agent that learns from its environment, from its mistakes (Reflexion), and from your chat history, and develops tools as needed (Voyager).\n\n# Usage\n\nYou can install this from [PyPi](https://pypi.org/project/voyager-dev/) with `pip install voyager_dev`.\n\nAlternatively, you can clone this repository. Then to install this repository as a global Python CLI tool, run `pip install -e .`\n\nEither way, you should also put your OpenAI and Google Search API keys in your .bashrc or .zshrc file, like this:\n\n```\nexport OPENAI_API_KEY=yourkeyhere\nexport GOOGLE_API_KEY=yourkeyhere\nexport GOOGLE_CSE_ID=yourkeyhere\n```\n\nYou can get the latter two by creating the GOOGLE_API_KEY in the [Google Cloud credential console](https://console.cloud.google.com/apis/credentials) and a GOOGLE_CSE_ID using the [Programmable Search Engine](https://programmablesearchengine.google.com/controlpanel/create). Examine the output carefully the first time you run it, Google may return a detailed error telling you how to fix it.\n\nAfter that, you can simply type `voyager_dev` anywhere on the command line.\n\n# Contributions and Issues\n\nPRs are very welcome! See the development roadmap below for ideas. You can open an issue here, but be sure to include helpful environmental information. I am unlikely to be of assistance for Windows issues, beyond advising you to move to OSX/*nix.\n\n# Development Roadmap\n\n- [x] Fix the terminal tool bug\n- [x] Get agent to ask for task. Maybe use prefix\n- [x] Install as command-line tool\n- [x] Install to PyPi (using the agent itself!)\n- [ ] On initialization, ask which files to embed\n- [ ] Add project structure and current location to every request\n- Agent does not always get input\n- Add persistent chat history per directory.\n- Only send up to maximum tokens. Use embeddings (or split with most recent). It crashes if terminal output is too long.\n- Add logging capabilities so we can see running terminal commands in a separate terminal with tail -f /path/to/logfile\n-- Also useful for sub-agents\n- Allow it to interrupt execution for subprocesses that ask for user input it does not have.\n- [Voyager](https://github.com/MineDojo/Voyager/tree/main/voyager) approach, build up skills list\n- Add a separate memory store for [Reflexion](https://github.com/noahshinn024/reflexion)\n- Maybe switch to Chroma for embeddings\n- Maybe use qlora to implement Toolformer. Can reflexion/Voyager provide training data?\n- Enable local LLM, a la GPT4All\n\n# Safety\n\nCurrently the shell/terminal command is the most unsafe tool given to this agent. While the prompt includes instructions to limit the damage, this is not an adequate substitute for actual safeguards.\n\nEnhance with:\n- Local LLM\n- Programmatic (not LLM) confirmation, or sandboxed LLM confirmation\n- Crypto signing tool for certain tasks\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A coding assistant for Python developers",
    "version": "0.1.0",
    "project_urls": {
        "Documentation": "https://github.com/yourusername/python-coding-assistant/blob/main/README.md",
        "Homepage": "https://github.com/yourusername/python-coding-assistant",
        "Source": "https://github.com/yourusername/python-coding-assistant",
        "Tracker": "https://github.com/yourusername/python-coding-assistant/issues"
    },
    "split_keywords": [
        "coding",
        "assistant"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f72984e083429c0ca5fe3b03fdb32cfbd7b8433e4b7ed93c382537bed3b75b5b",
                "md5": "a8d900789fc4fcc219becc21825ee287",
                "sha256": "1fcd644b3e10a56604cf6af49da14604192524afe50c71c2edf508d502986017"
            },
            "downloads": -1,
            "filename": "python_coding_assistant-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a8d900789fc4fcc219becc21825ee287",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 4496,
            "upload_time": "2023-06-03T22:39:10",
            "upload_time_iso_8601": "2023-06-03T22:39:10.898828Z",
            "url": "https://files.pythonhosted.org/packages/f7/29/84e083429c0ca5fe3b03fdb32cfbd7b8433e4b7ed93c382537bed3b75b5b/python_coding_assistant-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c87c4c94f741e03842003d8fa58f9c8ba10a11091e892ea55356b0cc3702efb1",
                "md5": "7c64bb7dbb4210e38aed2f184de610eb",
                "sha256": "2712d475902a10a29b61dc8ca55127ecc3c73e4f2497a447e6819e51e4ebd707"
            },
            "downloads": -1,
            "filename": "python-coding-assistant-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7c64bb7dbb4210e38aed2f184de610eb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 4221,
            "upload_time": "2023-06-03T22:39:13",
            "upload_time_iso_8601": "2023-06-03T22:39:13.667176Z",
            "url": "https://files.pythonhosted.org/packages/c8/7c/4c94f741e03842003d8fa58f9c8ba10a11091e892ea55356b0cc3702efb1/python-coding-assistant-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-03 22:39:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "yourusername",
    "github_project": "python-coding-assistant",
    "github_not_found": true,
    "lcname": "python-coding-assistant"
}
        
Elapsed time: 0.18961s