| Name | simpgit JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | |
| Summary | A tool to simplfy git operations |
| upload_time | 2023-06-12 20:19:42 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | BSD-3-Clause |
| keywords |
ai
llm
openai
developer-tools
git
nlp
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Simpgit
A tool to simplify git usage with sprinkles of AI magic.
Humans think in simpler terms than git operates in. This tool aims to bridge that gap by providing a simpler language to
do common git tasks. Plus an LLM can write your commit messages for you.
You can load recent information with `gs load`, save current changes with `gs save` and share them with `gs share`.
Behind the scenes it's exactly what you would expect from git, but with a simpler interface.
## Install
* Get an [openai api key](https://platform.openai.com/account/api-keys)
```bash
$ export OPENAI_API_KEY=...
$ pip install simpgit
```
## Usage
Within a repo, run:
```bash
(.venv) $ sg --help
```
```bash
Commands:
--help: show this help message and exit
save <message>: add files and commit changes. Massage is genereated if not provided
share <message>: Add, commit and push changes to git. Massage is genereated if not provided
load : pull changes from git
commit <message>: commit changes. Massage is genereated if not provided
Automations:
auto <save|share> <interval> --<detach>: run a service
list <save|share>: list running services
stop <save|share>: stop a service
```
## Basic Example
```bash
sg save
> Entering new StuffDocumentsChain chain...
> Entering new LLMChain chain...
Prompt after formatting:
Write a concise summary of the following:
...
> Finished chain.
Automated commit - 4 files:
writing README.md new instructions.
gitllm/__init__.py
gitllm/cli.py
gitllm/git.py
pyproject.toml
```
## Automation Example
```bash
$ sg auto commit 5 --detach
Running auto commit every 5.0 minutes in the background
$ sg list commit
Auto commit every 5.0 on pid 96641 in repo at /Users/yonatanalexander/development/xethub/gitllm
$ sg stop commit
Stopping auto-git commit - in <repo>
Stopping processes for commit...
Stopped auto 96641..
```
Raw data
{
"_id": null,
"home_page": "",
"name": "simpgit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "XetHub <contact@xethub.com>",
"keywords": "ai,llm,openai,developer-tools,git,nlp",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/7e/ff/e8165bf5c1cc11def8c400ef35947f49a6951c885fc1f555408cf1d76753/simpgit-0.0.2.tar.gz",
"platform": null,
"description": "# Simpgit\n\nA tool to simplify git usage with sprinkles of AI magic.\n\nHumans think in simpler terms than git operates in. This tool aims to bridge that gap by providing a simpler language to\ndo common git tasks. Plus an LLM can write your commit messages for you.\n\nYou can load recent information with `gs load`, save current changes with `gs save` and share them with `gs share`. \nBehind the scenes it's exactly what you would expect from git, but with a simpler interface.\n\n## Install\n\n* Get an [openai api key](https://platform.openai.com/account/api-keys)\n\n```bash\n$ export OPENAI_API_KEY=...\n$ pip install simpgit\n```\n\n## Usage\n\nWithin a repo, run:\n\n```bash \n(.venv) $ sg --help\n```\n\n```bash\nCommands:\n --help: show this help message and exit \n save <message>: add files and commit changes. Massage is genereated if not provided \n share <message>: Add, commit and push changes to git. Massage is genereated if not provided\n load : pull changes from git \n commit <message>: commit changes. Massage is genereated if not provided\n\nAutomations:\n auto <save|share> <interval> --<detach>: run a service\n list <save|share>: list running services\n stop <save|share>: stop a service\n```\n\n## Basic Example\n```bash\nsg save\n\n> Entering new StuffDocumentsChain chain...\n\n\n> Entering new LLMChain chain...\nPrompt after formatting:\nWrite a concise summary of the following:\n...\n> Finished chain.\nAutomated commit - 4 files:\n writing README.md new instructions.\ngitllm/__init__.py\ngitllm/cli.py\ngitllm/git.py\npyproject.toml\n```\n\n## Automation Example\n```bash\n$ sg auto commit 5 --detach\nRunning auto commit every 5.0 minutes in the background\n\n$ sg list commit\nAuto commit every 5.0 on pid 96641 in repo at /Users/yonatanalexander/development/xethub/gitllm\n\n$ sg stop commit\nStopping auto-git commit - in <repo>\nStopping processes for commit...\nStopped auto 96641..\n```\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A tool to simplfy git operations",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://xethub.com/xdssio/gitlm"
},
"split_keywords": [
"ai",
"llm",
"openai",
"developer-tools",
"git",
"nlp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "51b6024732b529dfe190392f371d20024265fa73ed9828ff1665bb9d35ecfb61",
"md5": "7915b506bb681572b3e7fd4bddfa1ce5",
"sha256": "ee07a9ddff152be0faba05150071c5ebc96e885f2b942d9fae64336c2e64c5ee"
},
"downloads": -1,
"filename": "simpgit-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7915b506bb681572b3e7fd4bddfa1ce5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5748,
"upload_time": "2023-06-12T20:19:40",
"upload_time_iso_8601": "2023-06-12T20:19:40.530969Z",
"url": "https://files.pythonhosted.org/packages/51/b6/024732b529dfe190392f371d20024265fa73ed9828ff1665bb9d35ecfb61/simpgit-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7effe8165bf5c1cc11def8c400ef35947f49a6951c885fc1f555408cf1d76753",
"md5": "88d3e0cf5aff1f8b2f05186443e7621b",
"sha256": "eeaee378f44dcecf45d10a827127c6fff59b02858bac5f53742f3b0b0df75b3b"
},
"downloads": -1,
"filename": "simpgit-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "88d3e0cf5aff1f8b2f05186443e7621b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 8051,
"upload_time": "2023-06-12T20:19:42",
"upload_time_iso_8601": "2023-06-12T20:19:42.285340Z",
"url": "https://files.pythonhosted.org/packages/7e/ff/e8165bf5c1cc11def8c400ef35947f49a6951c885fc1f555408cf1d76753/simpgit-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-12 20:19:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "simpgit"
}
