---
# 📘 `devDocs` – AI-Powered README Generator
`devDocs` is a command-line tool that automatically generates clean, professional `README.md` files by analyzing your **project structure**, **source code**, and any **existing documentation**.
Powered by the **Google Gemini API**, it's ideal for:
* 💡 Open-source contributors
* 🛠️ Internal dev tools
* 🚀 Hackathon projects needing docs fast
---
## 📂 Example Project Layout
Before and after running `devDocs`:
```bash
your-project/
├── src/
│ ├── main.py
│ └── utils.py
├── tests/
├── requirements.txt
├── LICENSE
├── docs/ # ← Generated by devDocs
└── README.md # ← Overwritten by devDocs (if chosen)
```
---
## ⚙️ How It Works
1. **Scans** project directory and source files
2. **Parses** content (code, comments, old README)
3. **Generates** documentation via Google Gemini
4. **Saves** output in Markdown format
### Optional Features
* Preserve existing README (unless `--overwrite` is set)
* Include/exclude specific files or folders via filters
---
## 📦 Installation
Install via pip:
```bash
pip install devDocs
```
---
## 🔑 Requirements
* Python 3.8+
* Google Gemini API Key (get one at [Google AI Studio](https://aistudio.google.com/))
---
## 🚀 Usage
Run inside your project’s root:
```bash
devDocs [OPTIONS]
```
Paste your **Gemini API key** when prompted.
### CLI Options
| Option | Description |
| --------------- | ------------------------------------------------- |
| `--path` | Root folder to scan (default: `.`) |
| `--name` | Project name to display in the README |
| `--description` | Short project summary |
| `--authors` | Comma-separated list of authors |
| `--keywords` | Comma-separated keywords (e.g., cli, docs, ai) |
| `--overwrite` | Overwrite existing `README.md` (default: False) |
| `--output` | Output folder (default: `docs/`) |
| `--exclude` | Comma-separated paths/extensions to exclude |
| `--include` | Comma-separated paths/extensions to force include |
---
### ✅ Example
```bash
devDocs --path . \
--name "Cool Dev Tool" \
--description "Generate AI-based READMEs effortlessly" \
--authors "Gantavya Bansal" \
--keywords "cli, docs, automation" \
--output docs \
--overwrite
```
---
## 🧠 Key Features
✅ Auto-generates structured `README.md`
✅ Respects original files unless `--overwrite`
✅ Fine-grained include/exclude control
✅ Generates a visual folder tree
✅ Clean output in a dedicated `--output` folder
✅ Backed by Google Gemini for high-quality results
---
## 🧱 Tech Stack
* Python 3.8+
* [`google-genai`](https://pypi.org/project/google-generativeai/)
* Built-in: `argparse`, `os`, `logging`, `time`
---
## 🛠️ Dev Notes
### Workflow
```
CLI args → Filter files → Extract context → Call Gemini → Write docs
```
### API Prompt Template
```python
system_instruction = '''
You are Gantavya Bansal, a senior engineer and technical writer.
Generate professional Markdown documentation using context from code and folder structure.
Include:
- Title
- Folder Tree
- Description
- Usage
- Tech Stack
- Known Issues
- Licensing
'''
```
---
## ⚠️ Limitations
* 📶 Requires internet (for Gemini API)
* 🔁 Retry logic for failed API calls is minimal
* ❌ Regex not yet supported in filters
* 📄 Only outputs `.md` format (Markdown)
---
## 📜 License
Released under the **MIT License**. Use, modify, and share freely — attribution appreciated.
---
## 🤝 Contribute
Found a bug or have an idea?
Open an issue or submit a PR — contributions are always welcome!
---
Raw data
{
"_id": null,
"home_page": null,
"name": "devDocs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "cli, documentation, readme, generator, google-gemini, ai, markdown, docs-generator, auto-readme, open-source",
"author": "Gantavya Bansal",
"author_email": "Gantavya Bansal <gantavyaoo@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e4/81/8f9da3fb17f4df8249c3887835cd85e8a451438922686dd06ff439a6f1ce/devdocs-2.0.7.tar.gz",
"platform": null,
"description": "\n---\n\n# \ud83d\udcd8 `devDocs` \u2013 AI-Powered README Generator\n\n`devDocs` is a command-line tool that automatically generates clean, professional `README.md` files by analyzing your **project structure**, **source code**, and any **existing documentation**.\n\nPowered by the **Google Gemini API**, it's ideal for:\n\n* \ud83d\udca1 Open-source contributors\n* \ud83d\udee0\ufe0f Internal dev tools\n* \ud83d\ude80 Hackathon projects needing docs fast\n\n---\n\n## \ud83d\udcc2 Example Project Layout\n\nBefore and after running `devDocs`:\n\n```bash\nyour-project/\n\u251c\u2500\u2500 src/\n\u2502 \u251c\u2500\u2500 main.py\n\u2502 \u2514\u2500\u2500 utils.py\n\u251c\u2500\u2500 tests/\n\u251c\u2500\u2500 requirements.txt\n\u251c\u2500\u2500 LICENSE\n\u251c\u2500\u2500 docs/ # \u2190 Generated by devDocs\n\u2514\u2500\u2500 README.md # \u2190 Overwritten by devDocs (if chosen)\n```\n\n---\n\n## \u2699\ufe0f How It Works\n\n1. **Scans** project directory and source files\n2. **Parses** content (code, comments, old README)\n3. **Generates** documentation via Google Gemini\n4. **Saves** output in Markdown format\n\n### Optional Features\n\n* Preserve existing README (unless `--overwrite` is set)\n* Include/exclude specific files or folders via filters\n\n---\n\n## \ud83d\udce6 Installation\n\nInstall via pip:\n\n```bash\npip install devDocs\n```\n\n---\n\n## \ud83d\udd11 Requirements\n\n* Python 3.8+\n* Google Gemini API Key (get one at [Google AI Studio](https://aistudio.google.com/))\n\n---\n\n## \ud83d\ude80 Usage\n\nRun inside your project\u2019s root:\n\n```bash\ndevDocs [OPTIONS]\n```\n\nPaste your **Gemini API key** when prompted.\n\n### CLI Options\n\n| Option | Description |\n| --------------- | ------------------------------------------------- |\n| `--path` | Root folder to scan (default: `.`) |\n| `--name` | Project name to display in the README |\n| `--description` | Short project summary |\n| `--authors` | Comma-separated list of authors |\n| `--keywords` | Comma-separated keywords (e.g., cli, docs, ai) |\n| `--overwrite` | Overwrite existing `README.md` (default: False) |\n| `--output` | Output folder (default: `docs/`) |\n| `--exclude` | Comma-separated paths/extensions to exclude |\n| `--include` | Comma-separated paths/extensions to force include |\n\n---\n\n### \u2705 Example\n\n```bash\ndevDocs --path . \\\n --name \"Cool Dev Tool\" \\\n --description \"Generate AI-based READMEs effortlessly\" \\\n --authors \"Gantavya Bansal\" \\\n --keywords \"cli, docs, automation\" \\\n --output docs \\\n --overwrite\n```\n\n---\n\n## \ud83e\udde0 Key Features\n\n\u2705 Auto-generates structured `README.md`\n\u2705 Respects original files unless `--overwrite`\n\u2705 Fine-grained include/exclude control\n\u2705 Generates a visual folder tree\n\u2705 Clean output in a dedicated `--output` folder\n\u2705 Backed by Google Gemini for high-quality results\n\n---\n\n## \ud83e\uddf1 Tech Stack\n\n* Python 3.8+\n* [`google-genai`](https://pypi.org/project/google-generativeai/)\n* Built-in: `argparse`, `os`, `logging`, `time`\n\n---\n\n## \ud83d\udee0\ufe0f Dev Notes\n\n### Workflow\n\n```\nCLI args \u2192 Filter files \u2192 Extract context \u2192 Call Gemini \u2192 Write docs\n```\n\n### API Prompt Template\n\n```python\nsystem_instruction = '''\nYou are Gantavya Bansal, a senior engineer and technical writer.\nGenerate professional Markdown documentation using context from code and folder structure.\nInclude:\n- Title\n- Folder Tree\n- Description\n- Usage\n- Tech Stack\n- Known Issues\n- Licensing\n'''\n```\n\n---\n\n## \u26a0\ufe0f Limitations\n\n* \ud83d\udcf6 Requires internet (for Gemini API)\n* \ud83d\udd01 Retry logic for failed API calls is minimal\n* \u274c Regex not yet supported in filters\n* \ud83d\udcc4 Only outputs `.md` format (Markdown)\n\n---\n\n## \ud83d\udcdc License\n\nReleased under the **MIT License**. Use, modify, and share freely \u2014 attribution appreciated.\n\n---\n\n## \ud83e\udd1d Contribute\n\nFound a bug or have an idea?\nOpen an issue or submit a PR \u2014 contributions are always welcome!\n\n---\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "AI-powered CLI tool that builds professional '*.md' documentation files of a project for internal teams using the Google Gemini API.",
"version": "2.0.7",
"project_urls": {
"Documentation": "https://github.com/bgantavya/devDocs#readme",
"Homepage": "https://github.com/bgantavya/devDocs",
"Issues": "https://github.com/bgantavya/devDocs/issues",
"Repository": "https://github.com/bgantavya/devDocs"
},
"split_keywords": [
"cli",
" documentation",
" readme",
" generator",
" google-gemini",
" ai",
" markdown",
" docs-generator",
" auto-readme",
" open-source"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a7c0e543777685b9a01ff4772fb026d45a495d6d5427461746c39236ab829115",
"md5": "1ae80f0252027f95028f6e075c2b76f7",
"sha256": "96033707d51212a55f1f16af7622e52d9ec19e47d6f8969a3ccfd1d4f312691c"
},
"downloads": -1,
"filename": "devdocs-2.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1ae80f0252027f95028f6e075c2b76f7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6973,
"upload_time": "2025-08-06T17:54:47",
"upload_time_iso_8601": "2025-08-06T17:54:47.399211Z",
"url": "https://files.pythonhosted.org/packages/a7/c0/e543777685b9a01ff4772fb026d45a495d6d5427461746c39236ab829115/devdocs-2.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e4818f9da3fb17f4df8249c3887835cd85e8a451438922686dd06ff439a6f1ce",
"md5": "8685f684c4f3bd3c8bb7d2fb3eec60a9",
"sha256": "2c583c9785b3ce14acff15cd69c93654babb8079af00093e529e11da58fbdd43"
},
"downloads": -1,
"filename": "devdocs-2.0.7.tar.gz",
"has_sig": false,
"md5_digest": "8685f684c4f3bd3c8bb7d2fb3eec60a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6964,
"upload_time": "2025-08-06T17:54:48",
"upload_time_iso_8601": "2025-08-06T17:54:48.790648Z",
"url": "https://files.pythonhosted.org/packages/e4/81/8f9da3fb17f4df8249c3887835cd85e8a451438922686dd06ff439a6f1ce/devdocs-2.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-06 17:54:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bgantavya",
"github_project": "devDocs#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "devdocs"
}
JSON
