README.md

metadata

title: TechdocsAPI
emoji: 🚀
colorFrom: green
colorTo: green
sdk: docker
app_file: TechdocsAPI/app.py
pinned: false

Techdocs: A code documentation generator

Introduction

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.

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.

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.

Installation

Download zip or Clone the repository and run the following command in the terminal to install the required packages.

We recommend using a virtual environment for the installation.

$ git clone https://github.com/HemanthSai7/Techdocs
$ cd Techdocs
$ pip install -r requirements.txt
$ -- Run backend
$ uvicorn app:app --reload # For running the FastAPI server
$ -- Run frontend
$ cd frontend
$ streamlit run app.py # For running the Streamlit App

Streamlit App

• Head over to the Website and signup/login to use the tool.
• Once you are logged in, Head over to 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.
• Copy the API KEY and paste it in the API KEY field in the Code
• Now, you can paste your code in the Code field and click on the Generate Documentation button.
• The generated documentation will be displayed in the Documentation field.

Demo and Screenshots

Demo Screenshot 1

Demo Screenshot 2

Demo Screenshot 3

Tech Stack Used

Team Members

Name	Github
Mayuresh Agashe	Mayuresh Agashe
Hemanth Sai Garladinne	Hemanth Sai Garladinne