Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/codewithdark-git/code-summarizer-and-bug-finder

Code Summarizer and Bug Finder is a Streamlit web application designed to simplify the process of summarizing code and identifying bugs using AI. Whether you're a developer looking to get a quick overview of your code's functionality or seeking assistance in debugging, this app can help streamline your workflow.
https://github.com/codewithdark-git/code-summarizer-and-bug-finder

app application chatbot gemini-api genai python python3 streamlit streamlit-webapp summerization summerizer webapp

Last synced: 1 day ago
JSON representation

Code Summarizer and Bug Finder is a Streamlit web application designed to simplify the process of summarizing code and identifying bugs using AI. Whether you're a developer looking to get a quick overview of your code's functionality or seeking assistance in debugging, this app can help streamline your workflow.

Awesome Lists containing this project

README

        

# Code Summarizer and Bug Finder

This Streamlit app allows users to summarize code and find bugs using AI.

## Table of Contents

- [Introduction](#introduction)
- [How to Use](#how-to-use)
- [Developer](#developer)
- [Usage](#usage)
- [Dependencies](#dependencies)
- [Installation](#installation)
- [Running the App](#running-the-app)

## Introduction

Code Summarizer and Bug Finder is a Streamlit web application designed to simplify the process of summarizing code and identifying bugs using AI. Whether you're a developer looking to get a quick overview of your code's functionality or seeking assistance in debugging, this app can help streamline your workflow.

## How to Use

To summarize code:
1. Enter your code in the text area under "Summarize Code".
2. Click the "Summarize" button.
3. The app will generate a summary of your code.

To find bugs in code:
1. Enter your code in the text area under "Find Bugs".
2. Click the "Find Bugs" button.
3. The app will identify any potential bugs and suggest improvements.

## Developer

This app was developed by [DarkCoder](https://github.com/darkcoder90). For inquiries, you can reach out to [[email protected]](mailto:[email protected]).

Connect with the developer:
- [GitHub](https://github.com/codewithdark-git)
- [LinkedIn](https://www.linkedin.com/in/codewithdark)
- [Facebook](https://www.facebook.com/codewithdark.fb)

## Usage

To use this app locally, follow the instructions below:

### Dependencies

Ensure you have the following dependencies installed:

- Python 3.x
- Streamlit
- google.generativeai (GenAI library)

### Installation

1. Clone this repository to your local machine:

```
git clone https://github.com/codewithdark-git/code-summarizer-bug-finder.git
```

2. Navigate to the project directory:

```
cd code-summarizer-bug-finder
```

3. Install the required dependencies:

```
pip install -r requirements.txt
```

### Running the App

Run the Streamlit app using the following command:

```
streamlit run app.py
```

Open your web browser and navigate to the URL provided by Streamlit to access the app.

## License

This project is licensed under the [MIT License](LICENSE).