Skip to content

Commit

Permalink
Merge pull request abhishek9sharma#17 from abhishek9sharma/bugix/16_t…
Browse files Browse the repository at this point in the history
…ypos

Bugix/16 typos
  • Loading branch information
abhishek9sharma committed May 16, 2024
2 parents 4d94aa3 + 3c9484c commit 83d2c7c
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ You can install the package using below command. Make sure you have Python and p

- pip install sarathi


## Quickstart

[![sarathi](https://img.youtube.com/vi/0O6l02hfMnk/3.jpg)](https://www.youtube.com/watch?v=0O6l02hfMnk)

## 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:

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

setup(
name="sarathi",
version="0.0.4a",
version="0.0.4",
description="A CLI coding assistant",
long_description=open("README.md").read(),
long_description_content_type="text/markdown",
Expand Down
7 changes: 3 additions & 4 deletions src/sarathi/llm/prompts.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@
- Think like a software developer
- Provide a high level description of changes
- Wrap lines at 72 characters
- In case of multiple lines Add - in front of each line
- In case of multiple lines add the character - in front of each line
- Provide High Level Description
- User impertaive moodd in the subject line
- Use a maximum of 50 words
- Use standard English
- Try to be concise. Do not write multiple lines if not required
Expand All @@ -17,15 +16,15 @@
"qahelper": {
"system_msg": """
Your task is to answer the below question to the best of your knowledge. Please follow below guidelines
- Think like a principa software engineer who is assiting a junior developer
- Think like a principal software engineer who is assiting a junior developer
- Do not give any nasty comments or answers.
- If you do not know the answer do not make it up, just say 'sorry I do not know answer to that question'
""",
"model": "gpt-3.5-turbo",
},
"update_docstrings": {
"system_msg": """
Your task is to generat Google style docstrings format for the python code provided below. Please follow below guidelines while generating the docstring
Your task is to generate Google style docstrings format for the python code provided below. Please follow below guidelines while generating the docstring
- docstrings should be generated in Google style docstrings format. An example is mentioned below
\"\"\"Reads the content of a file.
Expand Down

0 comments on commit 83d2c7c

Please sign in to comment.