# sarathi
A CLI coding assistant
## Installation
You can install the package from the GitHub repository using pip. Make sure you have Python and pip installed on your system.
- pip install sarathi
- pip install https://github.com/abhishek9sharma/sarathi.git
## Setting OpenAI API Key
To use certain features of this package, you need to set up your OpenAI API key. If you don't have one, you can sign up for an account on the [OpenAI website](https://openai.com/product). Once you have your API key, you can set it in your environment variables. Here's how you can do it:
### For Linux/macOS:
- export OPENAI_API_KEY=YOUR_API_KEY
## Usage
#### Generating Git Commit Messages
Sarathi provides a convenient command `sarathi git autocommit` to generate commit messages for Git commits.
- Stage the files you want to commit
- Run `sarathi git autocommit`. This command will automatically analyze your staged changes (using git add .), generate a commit message, and if you confirm will commit your changes to the repository with the generate message
#### Generating docstring messages
You can generate docstrings for your python code using the below commands.
- Run `sarathi docstrgen -f /scratchpad/ghmount/sarathi/src/sarathi/utils/formatters.py`. This command analyze the methods in the file passed and generates docstrings for functions if they do not exist.
- Run `sarathi docstrgen -d /scratchpad/ghmount/sarathi/src/sarathi/`. This command analyzes the methods in all files presend in the directory specified and generates docstrings for functions if they do not exist.
## Helpul references
- https://dev.to/taikedz/ive-parked-my-side-projects-3o62
- https://github.com/lightningorb/autocommit
Raw data
{
"_id": null,
"home_page": "https://github.com/abhishek9sharma/sarathi",
"name": "sarathi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "cli coding assistant",
"author": "Abhishek Sharma",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/26/bf/74f33b855745b96e3410cb4c1bfacc712eeef7819337c61fa0c302e23398/sarathi-0.0.3.tar.gz",
"platform": null,
"description": "# sarathi\nA CLI coding assistant\n\n\n## Installation\nYou can install the package from the GitHub repository using pip. Make sure you have Python and pip installed on your system.\n \n - pip install sarathi\n - pip install https://github.com/abhishek9sharma/sarathi.git\n\n## Setting OpenAI API Key\nTo use certain features of this package, you need to set up your OpenAI API key. If you don't have one, you can sign up for an account on the [OpenAI website](https://openai.com/product). Once you have your API key, you can set it in your environment variables. Here's how you can do it:\n\n### For Linux/macOS:\n\n - export OPENAI_API_KEY=YOUR_API_KEY\n\n\n## Usage\n\n#### Generating Git Commit Messages\nSarathi provides a convenient command `sarathi git autocommit` to generate commit messages for Git commits. \n- Stage the files you want to commit\n- Run `sarathi git autocommit`. This command will automatically analyze your staged changes (using git add .), generate a commit message, and if you confirm will commit your changes to the repository with the generate message\n\n#### Generating docstring messages\nYou can generate docstrings for your python code using the below commands.\n\n- Run `sarathi docstrgen -f /scratchpad/ghmount/sarathi/src/sarathi/utils/formatters.py`. This command analyze the methods in the file passed and generates docstrings for functions if they do not exist.\n- Run `sarathi docstrgen -d /scratchpad/ghmount/sarathi/src/sarathi/`. This command analyzes the methods in all files presend in the directory specified and generates docstrings for functions if they do not exist.\n\n\n## Helpul references\n - https://dev.to/taikedz/ive-parked-my-side-projects-3o62\n - https://github.com/lightningorb/autocommit\n \n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI coding assistant",
"version": "0.0.3",
"project_urls": {
"Bug Reports": "https://github.com/abhishek9sharma/sarathi/issues",
"Homepage": "https://github.com/abhishek9sharma/sarathi",
"Source": "https://github.com/abhishek9sharma/sarathi"
},
"split_keywords": [
"cli",
"coding",
"assistant"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc0cad7a7f8ffda39bbbaed9e01cb8adc223dd324edab52619d0154d29b928c6",
"md5": "79547724603f21f8ba1709d2b72b0abc",
"sha256": "2878bae03d55ab784512d679ab1f00ed830d4557cbe19a11bdfb0b1f8f8a5269"
},
"downloads": -1,
"filename": "sarathi-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "79547724603f21f8ba1709d2b72b0abc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 11244,
"upload_time": "2024-05-12T07:41:19",
"upload_time_iso_8601": "2024-05-12T07:41:19.332528Z",
"url": "https://files.pythonhosted.org/packages/dc/0c/ad7a7f8ffda39bbbaed9e01cb8adc223dd324edab52619d0154d29b928c6/sarathi-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "26bf74f33b855745b96e3410cb4c1bfacc712eeef7819337c61fa0c302e23398",
"md5": "6121acaf303ad18f6483ba3683e542a0",
"sha256": "09c712a3445e5cff95a773085b41e21401e6cdf3f23337dab2ffaba141793229"
},
"downloads": -1,
"filename": "sarathi-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "6121acaf303ad18f6483ba3683e542a0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9429,
"upload_time": "2024-05-12T07:41:20",
"upload_time_iso_8601": "2024-05-12T07:41:20.981467Z",
"url": "https://files.pythonhosted.org/packages/26/bf/74f33b855745b96e3410cb4c1bfacc712eeef7819337c61fa0c302e23398/sarathi-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-12 07:41:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "abhishek9sharma",
"github_project": "sarathi",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sarathi"
}
JSON
