ai-docify 1.1.2__tar.gz

ai_docify-1.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 John Spencer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ai_docify-1.1.2/PKG-INFO

@@ -0,0 +1,201 @@
+Metadata-Version: 2.4
+Name: ai-docify
+Version: 1.1.2
+Summary: A CLI tool for generating safe, NumPy/Sphinx style docstrings using AST parsing.
+Author-email: John Spencer <johnspencer97@live.co.uk>
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: openai
+Requires-Dist: python-dotenv
+Requires-Dist: rich
+Requires-Dist: tiktoken
+Requires-Dist: astunparse
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+[![PyPI version](https://badge.fury.io/py/ai-docify.svg)](https://badge.fury.io/py/ai-docify)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+# ai-docify 🤖
+
+**A simple, secure, and cost-aware CLI tool for generating high-quality NumPy/Sphinx style docstrings using AI.**
+
+`ai-docify` helps you document your Python code instantly using either cloud-based models (OpenAI) or local privacy-focused models (Ollama). It is designed to be **safe** (using AST parsing), **transparent** (pre-flight cost checks), and **non-destructive**.
+
+---
+
+## ✨ Key Features
+
+* **💰 Cost-Aware Design**: Calculates and displays the **estimated input token cost** via `tiktoken` *before* you spend a penny.
+* **🔒 Privacy-First**: Switch seamlessly between **OpenAI** (Cloud) and **Ollama** (Local) with a single flag. Keep proprietary code on your machine when needed.
+* **🛡️ AST-Powered Safety**: Unlike other tools that "guess" where to put text, `ai-docify` parses your code's Abstract Syntax Tree to surgically inject docstrings without breaking indentation or logic.
+* **↩️ The "Undo" Button**: Includes a `strip` command to safely remove all docstrings if you change your mind.
+* **✌️ Dual Generation Modes**: Choose between `rewrite` for speed/coverage, or `inject` for surgical precision.
+* **🎯 Granular Control**: Document an entire file or target a single function or class for surgical precision.
+* **⚡ "Lean" Architecture**: Optimized prompt engineering ensures high-quality documentation without wasting tokens on conversational fluff.
+
+---
+
+## 🚀 Installation
+
+Install `ai-docify` directly from PyPI:
+
+```bash
+pip install ai-docify
+
+```
+
+### Prerequisites
+
+* **Python 3.8+**
+* **[Ollama](https://ollama.com/)** (Optional, required only if using local models)
+
+### Setup (OpenAI Only)
+
+If you plan to use OpenAI models, set your API key as an environment variable:
+
+**Mac/Linux:**
+
+```bash
+export OPENAI_API_KEY=sk-your-api-key-here
+
+```
+
+**Windows (PowerShell):**
+
+```powershell
+$env:OPENAI_API_KEY="sk-your-api-key-here"
+
+```
+
+*(Alternatively, you can create a `.env` file in your project root)*
+
+---
+
+## 💻 VS Code Extension
+
+Prefer a GUI? This CLI powers the **AI Docify for VS Code** extension.
+👉 **[Download AI Docify for VS Code](https://github.com/sunman97-ui/ai-docify-vscode)
+
+---
+
+## 📖 Usage
+
+### 1. Generating Documentation
+
+You must specify the **Provider**, **Model**, and **Mode**.
+
+#### `inject` Mode (Recommended)
+
+*Best for: Surgical precision and preserving formatting.*
+Uses AST parsing to find functions and classes, injecting docstrings exactly where they belong without touching a single line of your actual code.
+
+```bash
+ai-docify generate my_script.py --provider openai --model gpt-5-mini --mode inject
+
+```
+
+#### `rewrite` Mode
+
+*Best for: Speed and heavy refactoring.*
+Asks the AI to rewrite the file with docs included. Good for initial drafts or undocumented legacy files.
+
+```bash
+# Using a local model (Free)
+ai-docify generate my_script.py --provider ollama --model llama3 --mode rewrite
+
+```
+
+### 2. Targeting a Single Function
+
+*Best for: Quickly documenting a specific piece of code you're working on.*
+
+Use the `--function` flag to target a single function or class by name. This is faster, cheaper, and automatically uses the safe `inject` mode.
+
+```bash
+# Target only the 'calculate_total' function in the file
+ai-docify generate utils.py --provider openai --model gpt-5-mini --function calculate_total
+```
+
+### 3. The Safety Check 🛡️
+
+Before generating anything, the tool will pause and show you an exact cost estimate:
+
+```text
+🤖 ai-docify: Checking my_script.py in INJECT mode
+
+📊 Estimation (Input Only):
+   Tokens: 350
+   Est. Cost: $0.00009
+
+Do you want to proceed? [y/n]:
+
+```
+
+### 3. Stripping Docstrings (Undo) ↩️
+
+Need to start over? The `strip` command uses AST parsing to cleanly remove all docstrings from a file, leaving your logic intact. It saves the clean version to a `stripped_scripts/` folder by default.
+
+```bash
+ai-docify strip my_script.py
+
+```
+
+### 4. Cleaning Output
+
+To remove all generated files from the default `ai_output/` directory:
+
+```bash
+ai-docify clean
+
+```
+
+---
+
+## ⚙️ Supported Models
+
+`ai-docify` comes pre-configured with pricing and token limits for popular models.
+
+**OpenAI:**
+
+* `o3-2025-04-16`
+* `gpt-5` / `gpt-5-mini` /  `gpt-5-nano`
+* `gpt-5.2`
+
+**Ollama (Local):**
+
+* `llama3.1:8b`
+* `qwen2.5-coder:7b`
+* (Any model pulled via `ollama pull` works with the `--provider ollama` flag)
+
+*Missing a model? Feel free to open an Issue or Pull Request to update the internal pricing configuration!*
+
+---
+
+## 🤝 Contributing
+
+We welcome contributions! Whether it's a bug fix, a new feature, or a better prompt template:
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/NewModel`)
+3. Commit your Changes (`git commit -m 'Add GPT-6 support'`)
+4. Push to the Branch (`git push origin feature/NewModel`)
+5. Open a Pull Request
+
+---
+
+## 📄 License
+
+Distributed under the MIT License. See `LICENSE` for more information.

ai_docify-1.1.2/README.md

@@ -0,0 +1,173 @@
+[![PyPI version](https://badge.fury.io/py/ai-docify.svg)](https://badge.fury.io/py/ai-docify)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+# ai-docify 🤖
+
+**A simple, secure, and cost-aware CLI tool for generating high-quality NumPy/Sphinx style docstrings using AI.**
+
+`ai-docify` helps you document your Python code instantly using either cloud-based models (OpenAI) or local privacy-focused models (Ollama). It is designed to be **safe** (using AST parsing), **transparent** (pre-flight cost checks), and **non-destructive**.
+
+---
+
+## ✨ Key Features
+
+* **💰 Cost-Aware Design**: Calculates and displays the **estimated input token cost** via `tiktoken` *before* you spend a penny.
+* **🔒 Privacy-First**: Switch seamlessly between **OpenAI** (Cloud) and **Ollama** (Local) with a single flag. Keep proprietary code on your machine when needed.
+* **🛡️ AST-Powered Safety**: Unlike other tools that "guess" where to put text, `ai-docify` parses your code's Abstract Syntax Tree to surgically inject docstrings without breaking indentation or logic.
+* **↩️ The "Undo" Button**: Includes a `strip` command to safely remove all docstrings if you change your mind.
+* **✌️ Dual Generation Modes**: Choose between `rewrite` for speed/coverage, or `inject` for surgical precision.
+* **🎯 Granular Control**: Document an entire file or target a single function or class for surgical precision.
+* **⚡ "Lean" Architecture**: Optimized prompt engineering ensures high-quality documentation without wasting tokens on conversational fluff.
+
+---
+
+## 🚀 Installation
+
+Install `ai-docify` directly from PyPI:
+
+```bash
+pip install ai-docify
+
+```
+
+### Prerequisites
+
+* **Python 3.8+**
+* **[Ollama](https://ollama.com/)** (Optional, required only if using local models)
+
+### Setup (OpenAI Only)
+
+If you plan to use OpenAI models, set your API key as an environment variable:
+
+**Mac/Linux:**
+
+```bash
+export OPENAI_API_KEY=sk-your-api-key-here
+
+```
+
+**Windows (PowerShell):**
+
+```powershell
+$env:OPENAI_API_KEY="sk-your-api-key-here"
+
+```
+
+*(Alternatively, you can create a `.env` file in your project root)*
+
+---
+
+## 💻 VS Code Extension
+
+Prefer a GUI? This CLI powers the **AI Docify for VS Code** extension.
+👉 **[Download AI Docify for VS Code](https://github.com/sunman97-ui/ai-docify-vscode)
+
+---
+
+## 📖 Usage
+
+### 1. Generating Documentation
+
+You must specify the **Provider**, **Model**, and **Mode**.
+
+#### `inject` Mode (Recommended)
+
+*Best for: Surgical precision and preserving formatting.*
+Uses AST parsing to find functions and classes, injecting docstrings exactly where they belong without touching a single line of your actual code.
+
+```bash
+ai-docify generate my_script.py --provider openai --model gpt-5-mini --mode inject
+
+```
+
+#### `rewrite` Mode
+
+*Best for: Speed and heavy refactoring.*
+Asks the AI to rewrite the file with docs included. Good for initial drafts or undocumented legacy files.
+
+```bash
+# Using a local model (Free)
+ai-docify generate my_script.py --provider ollama --model llama3 --mode rewrite
+
+```
+
+### 2. Targeting a Single Function
+
+*Best for: Quickly documenting a specific piece of code you're working on.*
+
+Use the `--function` flag to target a single function or class by name. This is faster, cheaper, and automatically uses the safe `inject` mode.
+
+```bash
+# Target only the 'calculate_total' function in the file
+ai-docify generate utils.py --provider openai --model gpt-5-mini --function calculate_total
+```
+
+### 3. The Safety Check 🛡️
+
+Before generating anything, the tool will pause and show you an exact cost estimate:
+
+```text
+🤖 ai-docify: Checking my_script.py in INJECT mode
+
+📊 Estimation (Input Only):
+   Tokens: 350
+   Est. Cost: $0.00009
+
+Do you want to proceed? [y/n]:
+
+```
+
+### 3. Stripping Docstrings (Undo) ↩️
+
+Need to start over? The `strip` command uses AST parsing to cleanly remove all docstrings from a file, leaving your logic intact. It saves the clean version to a `stripped_scripts/` folder by default.
+
+```bash
+ai-docify strip my_script.py
+
+```
+
+### 4. Cleaning Output
+
+To remove all generated files from the default `ai_output/` directory:
+
+```bash
+ai-docify clean
+
+```
+
+---
+
+## ⚙️ Supported Models
+
+`ai-docify` comes pre-configured with pricing and token limits for popular models.
+
+**OpenAI:**
+
+* `o3-2025-04-16`
+* `gpt-5` / `gpt-5-mini` /  `gpt-5-nano`
+* `gpt-5.2`
+
+**Ollama (Local):**
+
+* `llama3.1:8b`
+* `qwen2.5-coder:7b`
+* (Any model pulled via `ollama pull` works with the `--provider ollama` flag)
+
+*Missing a model? Feel free to open an Issue or Pull Request to update the internal pricing configuration!*
+
+---
+
+## 🤝 Contributing
+
+We welcome contributions! Whether it's a bug fix, a new feature, or a better prompt template:
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/NewModel`)
+3. Commit your Changes (`git commit -m 'Add GPT-6 support'`)
+4. Push to the Branch (`git push origin feature/NewModel`)
+5. Open a Pull Request
+
+---
+
+## 📄 License
+
+Distributed under the MIT License. See `LICENSE` for more information.

ai_docify-1.1.2/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ai-docify"
+version = "1.1.2"
+description = "A CLI tool for generating safe, NumPy/Sphinx style docstrings using AST parsing."
+readme = "README.md"  
+authors = [
+  { name = "John Spencer", email = "johnspencer97@live.co.uk" },
+]
+license = { text = "MIT" }
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Documentation",
+]
+requires-python = ">=3.8"
+dependencies = [
+    "click",
+    "openai",
+    "python-dotenv",
+    "rich",
+    "tiktoken",
+    "astunparse",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "black",
+    "flake8",
+    "pytest-cov",
+    "build",    # <--- Added 'build' so you can run 'python -m build' easily
+    "twine",    # <--- Added 'twine' for uploading to PyPI
+]
+
+[project.scripts]
+ai-docify = "ai_docify.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+ai_docify = ["templates/*.json", "pricing.json"]
+
+[tool.black]
+line-length = 88
+target-version = ['py38']
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+)/
+'''

ai_docify-1.1.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ai_docify-1.1.2/src/ai_docify/__init__.py

@@ -0,0 +1,4 @@
+__version__ = "0.1.0"
+from .cli import main  # Expose main CLI entry point
+
+__all__ = ["main"]

ai_docify-1.1.2/src/ai_docify/__main__.py

@@ -0,0 +1,4 @@
+from .cli import main
+
+if __name__ == "__main__":
+    main()