Spaces:
Runtime error
Runtime error
Commit
·
81c3cad
1
Parent(s):
be94910
readme 2
Browse files
README.md
CHANGED
@@ -1,44 +1,20 @@
|
|
1 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2 |
|
3 |
-
|
4 |
|
5 |
-
|
6 |
|
7 |
## Features
|
8 |
-
-
|
9 |
-
-
|
10 |
-
-
|
11 |
-
-
|
12 |
-
- Interactive Streamlit interface with visualizations
|
13 |
-
- Provides targeted answers to specific questions about the codebase
|
14 |
-
|
15 |
-
## Demo
|
16 |
-
You can try the live demo on [Hugging Face Spaces](https://huggingface.co/spaces/YOUR_USERNAME/code-analyzer)
|
17 |
-
|
18 |
-
## Local Setup
|
19 |
-
1. Install dependencies:
|
20 |
-
```bash
|
21 |
-
pip install -r requirements.txt
|
22 |
-
```
|
23 |
-
|
24 |
-
2. Run the Streamlit app:
|
25 |
-
```bash
|
26 |
-
streamlit run app.py
|
27 |
-
```
|
28 |
-
|
29 |
-
## Usage
|
30 |
-
1. Upload your code files (supported: .py, .java, .js, .jsx, .ts, .tsx)
|
31 |
-
2. Enter your analysis questions (or use the default ones)
|
32 |
-
3. Click "Analyze Code" to get insights about your project
|
33 |
-
|
34 |
-
## Analysis Capabilities
|
35 |
-
- Technology stack detection (languages, frameworks, dependencies)
|
36 |
-
- Code metrics (lines of code, class/function count, complexity)
|
37 |
-
- Project objective identification from documentation
|
38 |
-
- Customizable question-answering system
|
39 |
-
- Interactive visualizations of code metrics
|
40 |
-
|
41 |
-
## Requirements
|
42 |
-
- Python 3.8+
|
43 |
-
- 4GB+ RAM
|
44 |
-
- CUDA-capable GPU (optional, for faster processing)
|
|
|
1 |
+
---
|
2 |
+
title: Code to Doc Streamlit App
|
3 |
+
emoji: 📝
|
4 |
+
colorFrom: blue
|
5 |
+
colorTo: green
|
6 |
+
sdk: gradio
|
7 |
+
sdk_version: "3.3.0"
|
8 |
+
app_file: app.py
|
9 |
+
pinned: false
|
10 |
+
---
|
11 |
|
12 |
+
# Code to Doc Streamlit App
|
13 |
|
14 |
+
A Streamlit-based application that converts code to documentation.
|
15 |
|
16 |
## Features
|
17 |
+
- Code analysis
|
18 |
+
- Documentation generation
|
19 |
+
- Interactive interface
|
20 |
+
- Real-time updates
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|