Spaces:
Runtime error
Runtime error
G.Hemanth Sai
commited on
Commit
•
edf4ce0
1
Parent(s):
0392324
README
Browse files
README.md
CHANGED
|
@@ -1 +1,42 @@
|
|
| 1 |
-
# Techdocs
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Techdocs: A code documentation generator
|
| 2 |
+
|
| 3 |
+
## Introduction
|
| 4 |
+
|
| 5 |
+
**Code Documentation Generation** is a tool that generates documentation for your code. It is a simple tool that can be used by anyone who wants to generate documentation for their code. It leverages the power of **OpenAI GPT-3, Huggingface Transformers, Langchain and Clarifai** to generate documentation for your code.
|
| 6 |
+
|
| 7 |
+
To use the application, you need to provide your code as input. The tool will analyze your code and generate documentation for it. The documentation will include comments, descriptions, parameters, return values, examples, and more.
|
| 8 |
+
|
| 9 |
+
It is a useful tool for developers who want to document their code without spending too much time and effort. It can help you improve the readability, maintainability, and quality of your code. It can also help you share your code with others more easily.
|
| 10 |
+
|
| 11 |
+
## Installation
|
| 12 |
+
> Download zip or Clone the repository and run the following command in the terminal to install the required packages.
|
| 13 |
+
|
| 14 |
+
> We recommend using a virtual environment for the installation.
|
| 15 |
+
|
| 16 |
+
```bash
|
| 17 |
+
$ git clone https://github.com/HemanthSai7/Techdocs
|
| 18 |
+
$ cd Techdocs
|
| 19 |
+
$ pip install -r requirements.txt
|
| 20 |
+
$ -- Run backend
|
| 21 |
+
$ uvicorn app:app --reload # For running the FastAPI server
|
| 22 |
+
$ -- Run frontend
|
| 23 |
+
$ streamlit run app.py # For running the Streamlit App
|
| 24 |
+
```
|
| 25 |
+
|
| 26 |
+
## Streamlit App
|
| 27 |
+
- Head over to the [Website](https://techdocs.streamlit.app) and `signup/login` to use the tool.
|
| 28 |
+
- Once you are logged in, Head over to [Code](techdocs.streamlit.app/Code) page and generate your `API KEY` by clicking on the `Generate API KEY` button. Please note that the API KEY will be visible only once and you need to copy it and save it somewhere safe.
|
| 29 |
+
- Copy the API KEY and paste it in the `API KEY` field in the [Code](techdocs.streamlit.app/Code)
|
| 30 |
+
- Now, you can paste your code in the `Code` field and click on the `Generate Documentation` button.
|
| 31 |
+
- The generated documentation will be displayed in the `Documentation` field.
|
| 32 |
+
|
| 33 |
+
## Tech Stack Used
|
| 34 |
+
|
| 35 |
+
|
| 36 |
+
|
| 37 |
+
|
| 38 |
+
|
| 39 |
+
|
| 40 |
+
|
| 41 |
+
|
| 42 |
+
|