Skip to content

Latest commit

Β 

History

15 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Absolutely! Here's the complete, cleaned, and decorated README.md in a single block β€” ready for copy-paste:


# 🧠✨ Code Documentation Generator (LLM + Novita.ai)

This project uses **Python + FastAPI** with a **Novita.ai-powered LLM** to generate high-quality inline code comments and documentation from pasted or uploaded code.

> πŸš€ Ideal for developers building AI assistants, internal tools, or automated doc generators.

---

### 🐍 Create & Activate a Virtual Environment

#### πŸ’» Windows (Command Prompt)

```bash
python -m venv venv
venv\Scripts\activate
```

#### πŸͺŸ Windows (PowerShell)

```powershell
python -m venv venv
.\venv\Scripts\Activate.ps1
```

#### 🐧 Linux / macOS

```bash
python3 -m venv venv
source venv/bin/activate
```

---

### πŸ“¦ Install Dependencies

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

> πŸ’‘ Tip: Make sure you're inside the virtual environment before running this.

---

### πŸ” Add Environment Variables

Create a `.env` file in the `/backend` directory:

```env
NOVITA_API_KEY=your_novita_api_key_here
```

> πŸ›‘οΈ Keep this file secure and **do not commit it to version control**.

---

### πŸš€ Run the Application

#### 🏁 Basic Python Run:

```bash
python main.py
```

#### πŸ’» macOS/Linux Alternative:

```bash
uvicorn main:app --reload
```

## πŸ” Features

* βœ… Paste or upload code
* 🧠 Inline and function-level comments
* πŸ“„ JSON-style documentation output
* 🌐 Ready to plug into web UI or dev tools

## 🀝 Contributing

Feel free to fork this project, make changes, and submit pull requests. For major changes, please open an issue first to discuss what you'd like to change.

```

---

Let me know if you'd like a matching `.env.example`, `requirements.txt`, or frontend `README` too!
```

About

Hackthon project for LablabAi

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages