devDocs 2.0.3__tar.gz → 2.0.7__tar.gz

devdocs-2.0.7/PKG-INFO

@@ -0,0 +1,204 @@
+Metadata-Version: 2.4
+Name: devDocs
+Version: 2.0.7
+Summary: AI-powered CLI tool that builds professional '*.md' documentation files of a project for internal teams using the Google Gemini API.
+Author: Gantavya Bansal
+Author-email: Gantavya Bansal <gantavyaoo@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/bgantavya/devDocs
+Project-URL: Repository, https://github.com/bgantavya/devDocs
+Project-URL: Issues, https://github.com/bgantavya/devDocs/issues
+Project-URL: Documentation, https://github.com/bgantavya/devDocs#readme
+Keywords: cli,documentation,readme,generator,google-gemini,ai,markdown,docs-generator,auto-readme,open-source
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Documentation
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: google-genai
+Requires-Dist: httpx
+Dynamic: author
+Dynamic: requires-python
+
+
+---
+
+# 📘 `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!
+
+---

devdocs-2.0.7/README.md

@@ -0,0 +1,171 @@
+
+---
+
+# 📘 `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!
+
+---

devdocs-2.0.7/devDocs.egg-info/PKG-INFO

@@ -0,0 +1,204 @@
+Metadata-Version: 2.4
+Name: devDocs
+Version: 2.0.7
+Summary: AI-powered CLI tool that builds professional '*.md' documentation files of a project for internal teams using the Google Gemini API.
+Author: Gantavya Bansal
+Author-email: Gantavya Bansal <gantavyaoo@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/bgantavya/devDocs
+Project-URL: Repository, https://github.com/bgantavya/devDocs
+Project-URL: Issues, https://github.com/bgantavya/devDocs/issues
+Project-URL: Documentation, https://github.com/bgantavya/devDocs#readme
+Keywords: cli,documentation,readme,generator,google-gemini,ai,markdown,docs-generator,auto-readme,open-source
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Documentation
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: google-genai
+Requires-Dist: httpx
+Dynamic: author
+Dynamic: requires-python
+
+
+---
+
+# 📘 `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!
+
+---

devdocs-2.0.7/devDocs.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+devDocs = devDocs.cli:y

{devdocs-2.0.3 → devdocs-2.0.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "devDocs"
-version = "2.0.3"
+version = "2.0.7"
 description = "AI-powered CLI tool that builds professional '*.md' documentation files of a project for internal teams using the Google Gemini API."
 readme = "README.md"
 requires-python = ">=3.8"
@@ -49,7 +49,7 @@ Issues = "https://github.com/bgantavya/devDocs/issues"
 Documentation = "https://github.com/bgantavya/devDocs#readme"
 
 [project.scripts]
-devDocs = "devDocs.cli:x"
+devDocs = "devDocs.cli:y"
 
 [tool.setuptools]
 packages = ["devDocs"]

{devdocs-2.0.3 → devdocs-2.0.7}/setup.py

@@ -1,2 +1,2 @@
 from setuptools import setup,find_packages as A
-setup(name='devDocs',version='2.0.3',packages=A(),install_requires=['google-generativeai'],entry_points={'console_scripts':['devDocs=devDocs.cli:x']},author='Gantavya Bansal',description="Auto-generate Project's markdown documentation using Gemini AI for Internal teams.",long_description=open('README.md',encoding='utf-8').read(),long_description_content_type='text/markdown',license='MIT',python_requires='>=3.8',classifiers=['Programming Language :: Python :: 3','License :: OSI Approved :: MIT License'])
+setup(name='devDocs',version='2.0.7',packages=A(),install_requires=['google-generativeai'],entry_points={'console_scripts':['devDocs=devDocs.cli:y']},author='Gantavya Bansal',description="Auto-generate Project's markdown documentation using Gemini AI for Internal teams.",long_description=open('README.md',encoding='utf-8').read(),long_description_content_type='text/markdown',license='MIT',python_requires='>=3.8',classifiers=['Programming Language :: Python :: 3','License :: OSI Approved :: MIT License'])

devdocs-2.0.3/PKG-INFO

@@ -1,250 +0,0 @@
-Metadata-Version: 2.4
-Name: devDocs
-Version: 2.0.3
-Summary: AI-powered CLI tool that builds professional '*.md' documentation files of a project for internal teams using the Google Gemini API.
-Author: Gantavya Bansal
-Author-email: Gantavya Bansal <gantavyaoo@gmail.com>
-License: MIT
-Project-URL: Homepage, https://github.com/bgantavya/devDocs
-Project-URL: Repository, https://github.com/bgantavya/devDocs
-Project-URL: Issues, https://github.com/bgantavya/devDocs/issues
-Project-URL: Documentation, https://github.com/bgantavya/devDocs#readme
-Keywords: cli,documentation,readme,generator,google-gemini,ai,markdown,docs-generator,auto-readme,open-source
-Classifier: Development Status :: 4 - Beta
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Information Technology
-Classifier: Topic :: Documentation
-Classifier: Topic :: Software Development :: Code Generators
-Classifier: Topic :: Software Development :: Documentation
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: google-genai
-Requires-Dist: httpx
-Dynamic: author
-Dynamic: requires-python
-
-
----
-
-# PKG NAME📘: `devDocs` – AI-powered automated project documentation writer 
-
-`devDocs` is a **command-line tool** that automatically creates high-quality `README.md` files by analyzing your project’s **folder structure**, **source code**, and any existing documentation. It uses the **Google Gemini API** to generate clear, structured, and professional Markdown documentation.
-
-Perfect for:
-
-* Open-source contributors 💡
-* Developers maintaining internal tools 🛠️
-* Hackathon projects needing clean docs fast 🚀
-
----
-
-## 📂 Example Project Structure
-
-Here’s how your project might look before and after using `devDocs`:
-
-```bash
-your-project/
-├── src/
-│   ├── main.py
-│   └── utils.py
-├── tests/
-├── requirements.txt
-├── LICENSE
-└── README.md   <-- Generated/Overwritten by devDocs
-```
-
----
-
-## ⚙️ How It Works (Behind the Scenes)
-
-Here's what happens when you run `devDocs`:
-
-1. **Scans your project** – Analyzes directory structure, code files, and existing README files.
-2. **Parses content** – Gathers code and documentation from each relevant file/folder.
-3. **Generates documentation** – Sends context to Google Gemini API to craft a structured `README.md`.
-4. **Saves output** – Writes the generated Markdown into your project (or into a custom output folder).
-
-🔁 Optional features:
-
-* Preserves your original README unless you use `--overwrite`.
-* Includes/excludes specific files or folders with filters.
-
----
-
-## 📦 Installation
-
-Install from PyPI:
-
-```bash
-pip install devDocs
-```
-
----
-
-## 🔑 Requirements
-
-* **Python 3.8+**
-* **Google Gemini API Key**
-  Get one from [Google AI Studio](https://aistudio.google.com/).
-
----
-
-## 🚀 Usage
-
-Inside the root folder of your project, run:
-
-```bash
-devDocs [OPTIONS]
-```
-
-The CLI will prompt for your **Google Gemini API key**. Paste it once when asked.
-
-### CLI Options
-
-| Option          | Description                                                   |
-| --------------- | ------------------------------------------------------------- |
-| `--path`        | Root path to scan (default: current directory)                |
-| `--name`        | Project name to display in the README                         |
-| `--description` | Short description for the project                             |
-| `--authors`     | Comma-separated list of authors                               |
-| `--keywords`    | Comma-separated list of keywords (e.g., cli, docs, auto)      |
-| `--overwrite`   | Overwrite existing `README.md` files (default: False)         |
-| `--output`      | Output folder to save generated docs (default: `docs/`)       |
-| `--exclude`     | Comma-separated folders/files/extensions to **exclude**       |
-| `--include`     | Comma-separated folders/files/extensions to **force include** |
-
----
-
-### ✅ Example Command
-
-```bash
-devDocs --path . \
-        --name "Cool Dev Tool" \
-        --description "Generate AI-based READMEs effortlessly" \
-        --authors "Gantavya Bansal" \
-        --keywords "cli, docs, automation, openai" \
-        --output docs \
-        --overwrite
-```
-
-This will:
-
-* Walk through all folders from current directory
-* Create a `docs/README.md` and other structured markdowns
-* Overwrite existing README if one exists
-
----
-
-## 🧠 Features
-
-* ✅ Generates structured, professional `README.md` files automatically
-* ✅ Preserves original docs unless `--overwrite` is set
-* ✅ Supports **include/exclude** filtering for granular control
-* ✅ Smart project tree visualization included in docs
-* ✅ Outputs all documentation to a single folder (`--output`)
-* ✅ Powered by Google Gemini AI (clean & readable Markdown)
-
----
-
-## 🏗️ Example Output (Generated)
-
-Here’s a sample snippet of what the generated README might look like:
-
-```
-# Cool Dev Tool
-
-This is a CLI tool for generating clean README.md files using Google Gemini.
-
-## Folder Structure
-your-project/
-├── src/
-│   ├── main.py
-│   └── utils.py
-├── README.md
-...
-
-## Usage
-...
-```
-
----
-
-## 🧱 Technologies Used
-
-* `Python 3.8+`
-* [`google-genai`](https://pypi.org/project/google-generativeai/)
-* `argparse`, `os`, `logging`, `time` – for CLI and system interaction
-
----
-
-## 🧰 Developer Notes
-
-If you're contributing or extending this project:
-
-### Core Files
-
-| File               | Purpose                                         |
-| ------------------ | ----------------------------------------------- |
-| `cli.py`           | CLI interface + core logic                      |
-| `README.md`        | The README template output (can be regenerated) |
-| `LookFolder()`     | Recursive folder/file scanner                   |
-| `GenerateReadMe()` | Sends data to Gemini and processes results      |
-| `print_tree()`     | Generates folder structure view in tree format  |
-
-### Data Flow
-
-1. CLI parses args →
-2. Filters folders/files →
-3. Reads source + existing docs →
-4. Calls `GenerateReadMe()` →
-5. Writes Markdown to output
-
-### API Instruction Logic (Simplified)
-
-```python
-system_instruction = '''
-You are Gantavya Bansal, a senior engineer and tech writer.
-Generate clean, professional Markdown documentation using code + structure context.
-Include:
-- Title
-- Folder Tree
-- Description
-- Usage
-- Tech Stack
-- Known Issues
-- Licensing
-'''
-```
-
----
-
-## ⚠️ Known Limitations
-
-* 📡 Needs an internet connection for Gemini API
-* 🔁 Limited retry logic for failed API calls
-* ⚙️ Include/exclude filters don't yet support regex
-* 📄 Only supports `.md` output format
-
----
-
-## 📜 License
-
-**MIT License** – You’re free to use, modify, and share.
-Attribution is appreciated!
-
----
-
-## 💬 Contributing
-
-Feel free to open issues, suggest improvements, or contribute directly.
-Pull requests are always welcome!
-
----

devdocs-2.0.3/README.md

@@ -1,217 +0,0 @@
-
----
-
-# PKG NAME📘: `devDocs` – AI-powered automated project documentation writer 
-
-`devDocs` is a **command-line tool** that automatically creates high-quality `README.md` files by analyzing your project’s **folder structure**, **source code**, and any existing documentation. It uses the **Google Gemini API** to generate clear, structured, and professional Markdown documentation.
-
-Perfect for:
-
-* Open-source contributors 💡
-* Developers maintaining internal tools 🛠️
-* Hackathon projects needing clean docs fast 🚀
-
----
-
-## 📂 Example Project Structure
-
-Here’s how your project might look before and after using `devDocs`:
-
-```bash
-your-project/
-├── src/
-│   ├── main.py
-│   └── utils.py
-├── tests/
-├── requirements.txt
-├── LICENSE
-└── README.md   <-- Generated/Overwritten by devDocs
-```
-
----
-
-## ⚙️ How It Works (Behind the Scenes)
-
-Here's what happens when you run `devDocs`:
-
-1. **Scans your project** – Analyzes directory structure, code files, and existing README files.
-2. **Parses content** – Gathers code and documentation from each relevant file/folder.
-3. **Generates documentation** – Sends context to Google Gemini API to craft a structured `README.md`.
-4. **Saves output** – Writes the generated Markdown into your project (or into a custom output folder).
-
-🔁 Optional features:
-
-* Preserves your original README unless you use `--overwrite`.
-* Includes/excludes specific files or folders with filters.
-
----
-
-## 📦 Installation
-
-Install from PyPI:
-
-```bash
-pip install devDocs
-```
-
----
-
-## 🔑 Requirements
-
-* **Python 3.8+**
-* **Google Gemini API Key**
-  Get one from [Google AI Studio](https://aistudio.google.com/).
-
----
-
-## 🚀 Usage
-
-Inside the root folder of your project, run:
-
-```bash
-devDocs [OPTIONS]
-```
-
-The CLI will prompt for your **Google Gemini API key**. Paste it once when asked.
-
-### CLI Options
-
-| Option          | Description                                                   |
-| --------------- | ------------------------------------------------------------- |
-| `--path`        | Root path to scan (default: current directory)                |
-| `--name`        | Project name to display in the README                         |
-| `--description` | Short description for the project                             |
-| `--authors`     | Comma-separated list of authors                               |
-| `--keywords`    | Comma-separated list of keywords (e.g., cli, docs, auto)      |
-| `--overwrite`   | Overwrite existing `README.md` files (default: False)         |
-| `--output`      | Output folder to save generated docs (default: `docs/`)       |
-| `--exclude`     | Comma-separated folders/files/extensions to **exclude**       |
-| `--include`     | Comma-separated folders/files/extensions to **force include** |
-
----
-
-### ✅ Example Command
-
-```bash
-devDocs --path . \
-        --name "Cool Dev Tool" \
-        --description "Generate AI-based READMEs effortlessly" \
-        --authors "Gantavya Bansal" \
-        --keywords "cli, docs, automation, openai" \
-        --output docs \
-        --overwrite
-```
-
-This will:
-
-* Walk through all folders from current directory
-* Create a `docs/README.md` and other structured markdowns
-* Overwrite existing README if one exists
-
----
-
-## 🧠 Features
-
-* ✅ Generates structured, professional `README.md` files automatically
-* ✅ Preserves original docs unless `--overwrite` is set
-* ✅ Supports **include/exclude** filtering for granular control
-* ✅ Smart project tree visualization included in docs
-* ✅ Outputs all documentation to a single folder (`--output`)
-* ✅ Powered by Google Gemini AI (clean & readable Markdown)
-
----
-
-## 🏗️ Example Output (Generated)
-
-Here’s a sample snippet of what the generated README might look like:
-
-```
-# Cool Dev Tool
-
-This is a CLI tool for generating clean README.md files using Google Gemini.
-
-## Folder Structure
-your-project/
-├── src/
-│   ├── main.py
-│   └── utils.py
-├── README.md
-...
-
-## Usage
-...
-```
-
----
-
-## 🧱 Technologies Used
-
-* `Python 3.8+`
-* [`google-genai`](https://pypi.org/project/google-generativeai/)
-* `argparse`, `os`, `logging`, `time` – for CLI and system interaction
-
----
-
-## 🧰 Developer Notes
-
-If you're contributing or extending this project:
-
-### Core Files
-
-| File               | Purpose                                         |
-| ------------------ | ----------------------------------------------- |
-| `cli.py`           | CLI interface + core logic                      |
-| `README.md`        | The README template output (can be regenerated) |
-| `LookFolder()`     | Recursive folder/file scanner                   |
-| `GenerateReadMe()` | Sends data to Gemini and processes results      |
-| `print_tree()`     | Generates folder structure view in tree format  |
-
-### Data Flow
-
-1. CLI parses args →
-2. Filters folders/files →
-3. Reads source + existing docs →
-4. Calls `GenerateReadMe()` →
-5. Writes Markdown to output
-
-### API Instruction Logic (Simplified)
-
-```python
-system_instruction = '''
-You are Gantavya Bansal, a senior engineer and tech writer.
-Generate clean, professional Markdown documentation using code + structure context.
-Include:
-- Title
-- Folder Tree
-- Description
-- Usage
-- Tech Stack
-- Known Issues
-- Licensing
-'''
-```
-
----
-
-## ⚠️ Known Limitations
-
-* 📡 Needs an internet connection for Gemini API
-* 🔁 Limited retry logic for failed API calls
-* ⚙️ Include/exclude filters don't yet support regex
-* 📄 Only supports `.md` output format
-
----
-
-## 📜 License
-
-**MIT License** – You’re free to use, modify, and share.
-Attribution is appreciated!
-
----
-
-## 💬 Contributing
-
-Feel free to open issues, suggest improvements, or contribute directly.
-Pull requests are always welcome!
-
----

devdocs-2.0.3/devDocs.egg-info/PKG-INFO

@@ -1,250 +0,0 @@
-Metadata-Version: 2.4
-Name: devDocs
-Version: 2.0.3
-Summary: AI-powered CLI tool that builds professional '*.md' documentation files of a project for internal teams using the Google Gemini API.
-Author: Gantavya Bansal
-Author-email: Gantavya Bansal <gantavyaoo@gmail.com>
-License: MIT
-Project-URL: Homepage, https://github.com/bgantavya/devDocs
-Project-URL: Repository, https://github.com/bgantavya/devDocs
-Project-URL: Issues, https://github.com/bgantavya/devDocs/issues
-Project-URL: Documentation, https://github.com/bgantavya/devDocs#readme
-Keywords: cli,documentation,readme,generator,google-gemini,ai,markdown,docs-generator,auto-readme,open-source
-Classifier: Development Status :: 4 - Beta
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Information Technology
-Classifier: Topic :: Documentation
-Classifier: Topic :: Software Development :: Code Generators
-Classifier: Topic :: Software Development :: Documentation
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: google-genai
-Requires-Dist: httpx
-Dynamic: author
-Dynamic: requires-python
-
-
----
-
-# PKG NAME📘: `devDocs` – AI-powered automated project documentation writer 
-
-`devDocs` is a **command-line tool** that automatically creates high-quality `README.md` files by analyzing your project’s **folder structure**, **source code**, and any existing documentation. It uses the **Google Gemini API** to generate clear, structured, and professional Markdown documentation.
-
-Perfect for:
-
-* Open-source contributors 💡
-* Developers maintaining internal tools 🛠️
-* Hackathon projects needing clean docs fast 🚀
-
----
-
-## 📂 Example Project Structure
-
-Here’s how your project might look before and after using `devDocs`:
-
-```bash
-your-project/
-├── src/
-│   ├── main.py
-│   └── utils.py
-├── tests/
-├── requirements.txt
-├── LICENSE
-└── README.md   <-- Generated/Overwritten by devDocs
-```
-
----
-
-## ⚙️ How It Works (Behind the Scenes)
-
-Here's what happens when you run `devDocs`:
-
-1. **Scans your project** – Analyzes directory structure, code files, and existing README files.
-2. **Parses content** – Gathers code and documentation from each relevant file/folder.
-3. **Generates documentation** – Sends context to Google Gemini API to craft a structured `README.md`.
-4. **Saves output** – Writes the generated Markdown into your project (or into a custom output folder).
-
-🔁 Optional features:
-
-* Preserves your original README unless you use `--overwrite`.
-* Includes/excludes specific files or folders with filters.
-
----
-
-## 📦 Installation
-
-Install from PyPI:
-
-```bash
-pip install devDocs
-```
-
----
-
-## 🔑 Requirements
-
-* **Python 3.8+**
-* **Google Gemini API Key**
-  Get one from [Google AI Studio](https://aistudio.google.com/).
-
----
-
-## 🚀 Usage
-
-Inside the root folder of your project, run:
-
-```bash
-devDocs [OPTIONS]
-```
-
-The CLI will prompt for your **Google Gemini API key**. Paste it once when asked.
-
-### CLI Options
-
-| Option          | Description                                                   |
-| --------------- | ------------------------------------------------------------- |
-| `--path`        | Root path to scan (default: current directory)                |
-| `--name`        | Project name to display in the README                         |
-| `--description` | Short description for the project                             |
-| `--authors`     | Comma-separated list of authors                               |
-| `--keywords`    | Comma-separated list of keywords (e.g., cli, docs, auto)      |
-| `--overwrite`   | Overwrite existing `README.md` files (default: False)         |
-| `--output`      | Output folder to save generated docs (default: `docs/`)       |
-| `--exclude`     | Comma-separated folders/files/extensions to **exclude**       |
-| `--include`     | Comma-separated folders/files/extensions to **force include** |
-
----
-
-### ✅ Example Command
-
-```bash
-devDocs --path . \
-        --name "Cool Dev Tool" \
-        --description "Generate AI-based READMEs effortlessly" \
-        --authors "Gantavya Bansal" \
-        --keywords "cli, docs, automation, openai" \
-        --output docs \
-        --overwrite
-```
-
-This will:
-
-* Walk through all folders from current directory
-* Create a `docs/README.md` and other structured markdowns
-* Overwrite existing README if one exists
-
----
-
-## 🧠 Features
-
-* ✅ Generates structured, professional `README.md` files automatically
-* ✅ Preserves original docs unless `--overwrite` is set
-* ✅ Supports **include/exclude** filtering for granular control
-* ✅ Smart project tree visualization included in docs
-* ✅ Outputs all documentation to a single folder (`--output`)
-* ✅ Powered by Google Gemini AI (clean & readable Markdown)
-
----
-
-## 🏗️ Example Output (Generated)
-
-Here’s a sample snippet of what the generated README might look like:
-
-```
-# Cool Dev Tool
-
-This is a CLI tool for generating clean README.md files using Google Gemini.
-
-## Folder Structure
-your-project/
-├── src/
-│   ├── main.py
-│   └── utils.py
-├── README.md
-...
-
-## Usage
-...
-```
-
----
-
-## 🧱 Technologies Used
-
-* `Python 3.8+`
-* [`google-genai`](https://pypi.org/project/google-generativeai/)
-* `argparse`, `os`, `logging`, `time` – for CLI and system interaction
-
----
-
-## 🧰 Developer Notes
-
-If you're contributing or extending this project:
-
-### Core Files
-
-| File               | Purpose                                         |
-| ------------------ | ----------------------------------------------- |
-| `cli.py`           | CLI interface + core logic                      |
-| `README.md`        | The README template output (can be regenerated) |
-| `LookFolder()`     | Recursive folder/file scanner                   |
-| `GenerateReadMe()` | Sends data to Gemini and processes results      |
-| `print_tree()`     | Generates folder structure view in tree format  |
-
-### Data Flow
-
-1. CLI parses args →
-2. Filters folders/files →
-3. Reads source + existing docs →
-4. Calls `GenerateReadMe()` →
-5. Writes Markdown to output
-
-### API Instruction Logic (Simplified)
-
-```python
-system_instruction = '''
-You are Gantavya Bansal, a senior engineer and tech writer.
-Generate clean, professional Markdown documentation using code + structure context.
-Include:
-- Title
-- Folder Tree
-- Description
-- Usage
-- Tech Stack
-- Known Issues
-- Licensing
-'''
-```
-
----
-
-## ⚠️ Known Limitations
-
-* 📡 Needs an internet connection for Gemini API
-* 🔁 Limited retry logic for failed API calls
-* ⚙️ Include/exclude filters don't yet support regex
-* 📄 Only supports `.md` output format
-
----
-
-## 📜 License
-
-**MIT License** – You’re free to use, modify, and share.
-Attribution is appreciated!
-
----
-
-## 💬 Contributing
-
-Feel free to open issues, suggest improvements, or contribute directly.
-Pull requests are always welcome!
-
----

devdocs-2.0.3/devDocs.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-devDocs = devDocs.cli:x