AI-powered GitHub repository analyzer and README generator
Project description
ReadmeForge
AI-powered GitHub repository analyzer and README generator.
Features
- AI repository Q&A
- Semantic code search
- Automatic README generation
- Tech stack detection
- Repository architecture understanding
Installation
pip install readmeforge
Usage
from readmeforge import RepoAnalyzer
repo = RepoAnalyzer(
"https://github.com/user/repository"
)
repo.ingest()
answer = repo.ask(
"Where is authentication handled?"
)
print(answer)
README Generation
readme = repo.generate_readme(
save=True
)
CLI Usage
python main.py
Technologies Used
- Python
- ChromaDB
- Sentence Transformers
- Groq API
- Streamlit
Author
Anushka Dutta
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
codememoryai-0.1.0.tar.gz
(5.2 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file codememoryai-0.1.0.tar.gz.
File metadata
- Download URL: codememoryai-0.1.0.tar.gz
- Upload date:
- Size: 5.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5e130d4bc3f65915f96dbf902d21bc2735d8250fdc8f52b98f033a1ee72c704f
|
|
| MD5 |
7d55285014c28556c224f95338b382cf
|
|
| BLAKE2b-256 |
44e494bdda971cd545294312f6309c67285a31cb5f4326222522614760c56ec8
|
File details
Details for the file codememoryai-0.1.0-py3-none-any.whl.
File metadata
- Download URL: codememoryai-0.1.0-py3-none-any.whl
- Upload date:
- Size: 8.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dcd56b6e507c93ba4c83f7e80129c87b78110a94eb823e3580486bec7d380970
|
|
| MD5 |
b89bc21eb07488f4ff60551ae0f6b710
|
|
| BLAKE2b-256 |
118c706f67a1cf07a5e99445ec16705a730b3be56a9a18f114dcdfe696554714
|
