A Django web application that generates README files for code repositories.
Quill is a web app built with Django that allows users to input a GitHub repo URL and branch name. It will then download the repo code, analyze it, and generate a custom README.md file summarizing the project.
Key features:
- Parse local directories or clone remote GitHub repos
- Auto-generate table of contents
- Customizable templates
- Output as .md file, .html, or URL link
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Requirements for running the Quill app:
- Python 3.6+
- Django 4.2+
- Markdown and Mermaid libraries
Clone the repository locally:
git clone https://github.com/yourname/Quill.git
Install dependencies:
pip install -r requirements.txt
Make migrations:
python manage.py makemigrations
python manage.py migrate
Run development server:
python manage.py runserver
The app will now be running at https://localhost:8000
.
The main workflow is:
-
User submits GitHub repo URL and (optional) branch name
-
Quill clones the repo and reads all .py files
-
The codebase is passed to Claude AI to generate a custom README
-
User downloads the .md file or views it formatted as HTML
For example, to generate a README for https://github.com/anthropic/claude-quickstart:
Visit https://localhost:8000
Enter https://github.com/anthropic/claude-quickstart into the form
Click "Submit"
This will generate and download a README.md summarizing the repo.
graph TB
A[User] --> B{Index View}
B -- GET --> C[index.html]
C --> B
B -- POST --> D[Submit View]
D --"1. Get repo URL"--> E["Clone Repo <br/> Read Files"]
E -- Codebase --> F["Call Claude AI"]
F -- Markdown --> G["Output as .md, <br/> .html, or link"]
G --> A
Please reach out for contribution guidelines.