codyhelp 1.0.0__tar.gz

codyhelp-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Aleena Anil
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

codyhelp-1.0.0/PKG-INFO

@@ -0,0 +1,8 @@
+Metadata-Version: 2.4
+Name: codyhelp
+Version: 1.0.0
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: openai
+Dynamic: license-file
+Dynamic: requires-dist

codyhelp-1.0.0/README.md

@@ -0,0 +1,83 @@
+# CodyHelp
+CodyHelp is a command-line interface tool that can analyse source code files, provide explanations, detect possible bugs, and suggest improvements.
+
+Built for CS students and junior developers who are tired of switching between browser tabs, forgetting syntax, and blanking out when asked "can you walk me through this code?"
+
+## Goal:
+To build a lightweight developer assistant that works directly in the terminal, similar to modern AI coding tools.
+
+## Inspiration:
+As a CS student, I constantly found myself stuck, such as, forgetting syntax, not knowing how to explain my own code, and dreading the "walk me through this" question in interviews.
+
+CodyHelp was built to fix that. It's the tool I wish I had when I started coding.
+
+## Core Features:
+* Explain code files
+* Interview mode code explanation
+* Detect possible bugs in code
+* Review code and suggest improvements
+* Error explanation from stack traces
+* Support multiple programming languages
+
+## Installation
+pip install codyhelp
+
+## Setup
+1. Get a free GitHub Models token at github.com/marketplace/models
+2. Set your token:
+   - Windows: $env:GITHUB_TOKEN="your_token_here"
+   - Mac/Linux: export GITHUB_TOKEN="your_token_here"
+3. You're ready to use it!
+
+## Usage
+codyhelp explain main.py
+
+codyhelp explain main.py --interview
+
+codyhelp review main.py
+
+codyhelp stacktrace error.txt
+
+## Example:
+**Run CodyHelp from the terminal:**
+
+codyhelp explain linkedList.py --interview
+
+**Example output:**
+
+INTERVIEW MODE — linked_list.py
+
+How to explain this in an interview:
+
+"This implements a singly linked list with insert and traversal operations. Each node stores a value and a pointer to the next node, giving us dynamic memory allocation unlike arrays..."
+
+Complexity to mention:
+
++ Insert at head: O(1)
++ Search: O(n)
++ Space: O(n)
+
+Follow-up questions an interviewer might ask:
+
+* "How would you detect a cycle in this linked list?"
+* "How is this different from a doubly linked list?"
+* "When would you choose a linked list over an array?"
+
+Concepts you should know to fully defend this code:
+
++ Node structure and pointers
++ Dynamic vs static memory allocation
++ Singly vs doubly linked lists
+  
+## Technologies
+
+- Python
+- CLI (Command-line interface)
+- Github models
+- Git and Github
+
+## Future Improvements
+
+- [ ] Git diff code review
+- [ ] Repository-level code understanding
+- [ ] Leetcode practice suggestions

codyhelp-1.0.0/codyhelp/cli.py

@@ -0,0 +1,106 @@
+#CODYHELP V1
+
+import click
+from openai import OpenAI
+import os
+
+from codyhelp.prompts import explain_prompt, interview_prompt, review_prompt, stacktrace_prompt
+
+api_key=os.environ.get("GITHUB_TOKEN")
+if not api_key:
+    raise EnvironmentError("GITHUB_TOKEN environment variable is not set.")
+
+client = OpenAI(base_url="https://models.inference.ai.azure.com", api_key=api_key)
+
+@click.group()
+def main():
+    pass
+
+#Explain a code file.
+
+@main.command()
+@click.argument("file")
+@click.option("--interview", is_flag=True, help="Explain in interview mode")
+
+def explain(file, interview):
+    try:
+        with open(file, "r") as f:
+            code = f.read()
+    except FileNotFoundError:
+        click.echo(f"Error: File '{file}' not found.")
+        return
+
+    if interview:
+        prompt = interview_prompt(code)
+    else:
+        prompt = explain_prompt(code)
+
+    click.echo("\n ANALYSING...\n")
+
+    try:
+        response = client.chat.completions.create(
+            model="gpt-4o-mini",
+            messages=[{"role": "user", "content": prompt}]
+        )
+
+        click.echo(response.choices[0].message.content)
+
+    except Exception as e:
+        click.echo(f"Error while calling API: {str(e)}")
+
+#Reviews code and suggests improvements
+
+@main.command()
+@click.argument("file")
+
+def review(file):
+    try:
+        with open (file,"r") as f:
+            code=f.read()
+    except FileNotFoundError:
+        click.echo(f"Error: File '{file}' not found.")
+        return
+    
+    prompt = review_prompt(code)
+
+    click.echo("\n ANALYSING...\n")
+
+    try:
+        response = client.chat.completions.create(
+            model="gpt-4o-mini",
+            messages=[{"role": "user", "content": prompt}]
+        )
+
+        click.echo(response.choices[0].message.content)
+
+    except Exception as e:
+        click.echo(f"Error while calling API: {str(e)}")
+
+#Error explanation through stacktraces
+
+@main.command()
+@click.argument("file")
+
+def stacktrace(file):
+    try:
+        with open(file,"r") as f:
+            error=f.read()
+    except FileNotFoundError:
+        click.echo(f"Error: File '{file}' not found. ")
+        return
+    
+    prompt= stacktrace_prompt(error)
+
+    click.echo("\n ANALYSING...\n")
+
+    try:
+        response=client.chat.completions.create(
+            model="gpt-4o-mini",
+            messages=[{"role":"user", "content":prompt}]
+        )
+        
+        click.echo(response.choices[0].message.content)
+
+    except Exception as e:
+        click.echo(f"Error while calling API: {str(e)}")
+    

codyhelp-1.0.0/codyhelp/prompts.py

@@ -0,0 +1,13 @@
+#Prompts that are used to run each feature giving accurate responses to the user
+
+def explain_prompt(code):
+    return f"Explain what this code does in simple terms:\n\n{code}"
+
+def interview_prompt(code):
+    return f"Explain this code as if I need to defend it in a job interview. Include: how to explain it verbally, time/space complexity, likely follow-up questions, and key concepts to know.\n\n{code}"
+
+def review_prompt(code):
+    return f"Review this code and detect possible bugs. For each bug found, label it with a severity level: [HIGH], [MEDIUM], or [LOW]. Then suggest improvements.\n\n{code}"
+
+def stacktrace_prompt(error):
+    return f"You are a helpful coding assistant, explain errors in my code in simple words in the format:\n Error:\n What went wrong:\n Suggested fix:\n Concept to review:\n\n{error}"

codyhelp-1.0.0/codyhelp.egg-info/PKG-INFO

@@ -0,0 +1,8 @@
+Metadata-Version: 2.4
+Name: codyhelp
+Version: 1.0.0
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: openai
+Dynamic: license-file
+Dynamic: requires-dist

codyhelp-1.0.0/codyhelp.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+setup.py
+codyhelp/__init__.py
+codyhelp/cli.py
+codyhelp/prompts.py
+codyhelp.egg-info/PKG-INFO
+codyhelp.egg-info/SOURCES.txt
+codyhelp.egg-info/dependency_links.txt
+codyhelp.egg-info/entry_points.txt
+codyhelp.egg-info/requires.txt
+codyhelp.egg-info/top_level.txt

codyhelp-1.0.0/codyhelp.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

codyhelp-1.0.0/codyhelp.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+codyhelp = codyhelp.cli:main

codyhelp-1.0.0/codyhelp.egg-info/requires.txt

@@ -0,0 +1,2 @@
+click
+openai

codyhelp-1.0.0/codyhelp.egg-info/top_level.txt

@@ -0,0 +1 @@
+codyhelp

codyhelp-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

codyhelp-1.0.0/setup.py

@@ -0,0 +1,16 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="codyhelp",
+    version="1.0.0",
+    packages=find_packages(),
+    install_requires=[
+        "click",
+        "openai",
+    ],
+    entry_points={
+        "console_scripts": [
+            "codyhelp=codyhelp.cli:main",
+        ],
+    },
+)