commandor-ai 1.0.1__tar.gz

commandor_ai-1.0.1/LICENSE

@@ -0,0 +1,92 @@
+# Commandor License
+
+## Open Source License with Commercial Attribution Requirements
+
+This software is **free and open source** for all users, with specific attribution requirements for commercial use.
+
+### Personal/Individual Use (Free)
+
+**Permission is hereby granted, free of charge, to any individual** to use, copy, modify, distribute, and contribute to this software for **personal, educational, or non-commercial purposes** without any restrictions or attribution requirements.
+
+### Commercial Use (Free with Attribution)
+
+**Commercial use is permitted free of charge**, provided that commercial users comply with the following attribution requirements:
+
+**Required Attribution:**
+- Display **"Powered by Commandor"** prominently in your product interface, documentation, or about section
+- Include a clickable link to the official repository: `https://github.com/ravin-d-27/Commandor`
+- Mention Commandor in relevant marketing materials, press releases, or product announcements
+- If feasible, submit a brief case study or testimonial about your usage for our community showcase
+
+**Commercial use includes:**
+- Use by organizations or businesses of any size
+- Integration into commercial products or services
+- Use that generates revenue or commercial benefit
+- Use by government agencies or institutions
+
+### Contributions Welcome
+
+**All contributions are welcome and encouraged:**
+- Pull requests, bug reports, and feature suggestions are appreciated
+- Contributors retain copyright to their contributions
+- By contributing, you agree your contributions will be licensed under the same terms
+- All contributors will be acknowledged in the project documentation
+
+### Reproduction and Redistribution
+
+**Permitted:**
+- ✅ Fork the repository and create derivatives
+- ✅ Modify and distribute modified versions
+- ✅ Use components in other projects
+- ✅ Create packages or distributions
+
+**Required for Reproduction/Redistribution:**
+- ❌ **You may NOT claim this software as your own original work**
+- ❌ **You may NOT remove or modify copyright notices**
+- ❌ **You may NOT redistribute without including this license**
+- ✅ **You MUST clearly indicate if changes were made**
+- ✅ **You MUST provide attribution to the original project**
+
+### Attribution Requirements for Derivatives
+
+If you create a derivative work or redistribute this software:
+- Include original copyright notice and this license
+- Clearly state that your work is based on Commandor
+- Provide link to the original repository
+- If you've made modifications, clearly indicate what was changed
+
+### Open Source Commitment
+
+This project is committed to remaining **free and open source forever**:
+- No future license changes that restrict existing freedoms
+- Community-driven development
+- Transparent decision making
+- Welcoming to all contributors regardless of background
+
+### Enforcement and Compliance
+
+- Attribution compliance is verified through community monitoring
+- Non-compliance will result in polite contact requesting correction
+- Repeated violations may result in license termination for that user
+- Community members are encouraged to report non-compliance
+
+### Definitions
+
+- **Personal Use**: Use by individuals for their own personal, educational, or research purposes
+- **Commercial Use**: Any use by organizations, businesses, or for commercial advantage
+- **Attribution**: Proper credit given to the original project and maintainers
+- **Derivative Work**: Software that incorporates, modifies, or builds upon this project
+
+### Disclaimer
+
+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.
+
+---
+
+**Copyright (c) 2025 Ravin D**
+
+**This software is proudly open source and free for everyone!**
+
+For questions about attribution requirements or to submit your case study, contact: [your-email@example.com]
+
+**⭐ If this project helps you, please star it on GitHub to help others discover it!**

commandor_ai-1.0.1/MANIFEST.in

@@ -0,0 +1,12 @@
+# Include the README and LICENSE files
+include README.md
+include LICENSE
+
+# Include all files inside the commandor package that aren't .py
+recursive-include commandor *
+
+# Exclude unnecessary files (optional but good practice)
+global-exclude *.pyc __pycache__ *.pyo *.pyd *.swp *.bak
+
+# Include any other data files, e.g., configs/templates if you have them
+# recursive-include commandor/templates *

commandor_ai-1.0.1/PKG-INFO

@@ -0,0 +1,380 @@
+Metadata-Version: 2.4
+Name: commandor-ai
+Version: 1.0.1
+Summary: An intelligent terminal assistant that uses AI to convert natural language to shell commands
+Home-page: https://github.com/ravin-d-27/Commandor
+Author: Ravin D
+Author-email: Ravin D <ravin.d3107@outlook.com>
+License: Proprietary
+Project-URL: Homepage, https://github.com/ravin-d-27/Commandor
+Project-URL: BugReports, https://github.com/ravin-d-27/Commandor/issues
+Project-URL: Source, https://github.com/ravin-d-27/Commandor
+Project-URL: Documentation, https://github.com/ravin-d-27/Commandor#readme
+Keywords: terminal,ai,shell,command-line,natural-language,gemini,assistant,automation,cli,productivity
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: Free for non-commercial use
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+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: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Shells
+Classifier: Topic :: System :: System Shells
+Classifier: Topic :: Terminals
+Classifier: Topic :: Utilities
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: google-generativeai>=0.3.0
+Requires-Dist: python-decouple>=3.6
+Requires-Dist: colorama>=0.4.4
+Provides-Extra: windows
+Requires-Dist: pyreadline3>=3.4.1; extra == "windows"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# Commandor
+
+An intelligent terminal assistant that uses AI to convert natural language to shell commands and answer questions directly.
+
+[![GitHub stars](https://img.shields.io/github/stars/ravin-d-27/Commandor?style=social)](https://github.com/ravin-d-27/Commandor/stargazers)
+[![License](https://img.shields.io/badge/License-Open%20Source%20with%20Attribution-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/Python-3.6%2B-blue.svg)](https://python.org)
+
+## ✨ Latest Features (v2.0)
+
+### 🤖 **Direct AI Chat with `/ask`**
+Ask the AI assistant any question directly without generating commands! Perfect for:
+- Getting programming help and explanations
+- Learning new concepts and best practices
+- Technical troubleshooting and advice
+- General knowledge queries
+
+### 🎨 **Beautiful Colorful Interface**
+- **Stunning ASCII art logo** with rainbow colors
+- **Enhanced visual experience** with emojis and improved styling
+- **Better color coding** for different command types
+- **Professional yet fun** terminal presentation
+
+## Core Features
+
+- **🧠 AI-powered natural language to shell command conversion**
+- **💬 Direct AI questioning and assistance**
+- **🌈 Colorized output and beautiful terminal interface**
+- **📚 Command history with readline support**
+- **🛡️ Safety checks for dangerous commands**
+- **🖥️ Cross-platform support** (Windows, macOS, Linux)
+- **📍 Context-aware suggestions** based on current directory
+
+## Installation
+
+### Install from Source (Recommended)
+
+1. **Clone or download the project files**
+   ```bash
+   git clone https://github.com/ravin-d-27/Commandor.git
+   cd commandor
+   ```
+
+2. **Verify the directory structure:**
+   ```
+   Commandor/
+   ├── setup.py
+   ├── requirements.txt
+   ├── README.md
+   ├── LICENSE
+   ├── .gitignore
+   └── commandor/
+       ├── __init__.py
+       ├── main.py
+       └── terminal.py
+   ```
+
+3. **Install the package:**
+   ```bash
+   pip install -e .
+   ```
+
+4. **Set up your environment:**
+   Create a `.env` file in your home directory or project directory:
+   ```bash
+   echo "GEMINI=your_gemini_api_key_here" > ~/.env
+   ```
+
+## Setup
+
+1. **Get a Gemini API Key:**
+   - Go to [Google AI Studio](https://makersuite.google.com/app/apikey)
+   - Create a new API key
+   - Copy the key
+
+2. **Configure the environment:**
+   Create a `.env` file in your home directory:
+   ```bash
+   echo "GEMINI=your_api_key_here" > ~/.env
+   ```
+
+   Or set it as an environment variable:
+   ```bash
+   export GEMINI=your_api_key_here
+   ```
+
+## Usage
+
+Once installed, you can start Commandor from anywhere in your terminal:
+
+```bash
+commandor
+```
+
+### Available Commands
+
+| Command | Description | New! |
+|---------|-------------|------|
+| `/ai <instruction>` | Convert natural language to shell command | |
+| `/ask <question>` | Ask AI any question directly | ✨ **NEW** |
+| `/help` | Show help message | |
+| `/info` | Show system information | |
+| `/history` | Show command history | |
+| `/clear` | Clear the screen | |
+| `exit` or `Ctrl+C` | Exit Commandor | |
+
+### Command Generation Examples
+
+```bash
+commandor
+🚀 COMMANDOR - Your AI-Powered Terminal Assistant 🚀
+
+Commandor $ /ai list all python files
+🤖 AI → find . -name "*.py" -type f
+
+Commandor $ /ai create a directory called projects
+🤖 AI → mkdir projects
+
+Commandor $ /ai show disk usage
+🤖 AI → df -h
+
+Commandor $ /ai find large files over 100MB
+🤖 AI → find . -type f -size +100M -exec ls -lh {} \;
+```
+
+### ✨ NEW: Direct AI Questions
+
+Ask the AI assistant anything directly without generating commands:
+
+```bash
+Commandor $ /ask What is the difference between Python and JavaScript?
+🤔 Thinking...
+
+🤖 AI Response:
+──────────────────────────────────────────────────
+Python and JavaScript are both popular programming languages but serve different purposes:
+
+**Python:**
+- General-purpose language, great for data science, AI, web backends
+- Interpreted, readable syntax
+- Strong in scientific computing and automation
+- Used for desktop applications, web servers, data analysis
+
+**JavaScript:**
+- Originally for web browsers, now also server-side (Node.js)
+- Essential for web development and interactive websites
+- Event-driven and asynchronous
+- Used for frontend, backend, and mobile apps
+
+Both are beginner-friendly but excel in different domains!
+──────────────────────────────────────────────────
+
+Commandor $ /ask How do I optimize my Python code for better performance?
+🤔 Thinking...
+
+🤖 AI Response:
+──────────────────────────────────────────────────
+Here are key strategies for Python optimization:
+
+1. **Use built-in functions** - They're implemented in C and much faster
+2. **List comprehensions** - Faster than traditional loops
+3. **Avoid global variables** - Local variables are accessed faster
+4. **Use appropriate data structures** - Sets for membership testing, deques for queues
+5. **Profile your code** - Use cProfile to find bottlenecks
+6. **NumPy for numerical operations** - Vectorized operations are much faster
+7. **Cache expensive function calls** - Use @lru_cache decorator
+8. **Use generators** - For memory-efficient iteration
+
+Focus on the biggest bottlenecks first for maximum impact!
+──────────────────────────────────────────────────
+```
+
+### More `/ask` Examples
+
+```bash
+# Programming Help
+/ask Explain machine learning concepts for beginners
+/ask What are Git best practices?
+/ask How do I debug memory leaks in Python?
+
+# System Administration
+/ask What are the differences between various Linux distributions?
+/ask How do I secure my server?
+/ask Explain Docker vs Virtual Machines
+
+# General Learning
+/ask What is quantum computing?
+/ask How does blockchain technology work?
+/ask Explain REST APIs
+```
+
+## Troubleshooting
+
+### Command not found
+
+If you get "commandor: command not found":
+
+1. **Check if the package is installed:**
+   ```bash
+   pip show commandor
+   ```
+
+2. **Check your PATH:**
+   ```bash
+   echo $PATH
+   ```
+
+3. **Find where pip installs scripts:**
+   ```bash
+   python -m site --user-base
+   ```
+
+4. **Add to PATH if needed (add to your `.bashrc` or `.zshrc`):**
+   ```bash
+   export PATH="$PATH:$(python -m site --user-base)/bin"
+   ```
+
+### API Key Issues
+
+- Make sure your `.env` file contains: `GEMINI=your_actual_api_key`
+- Verify the API key is valid at [Google AI Studio](https://makersuite.google.com/app/apikey)
+- Check that the `.env` file is in your home directory or current working directory
+
+### Windows Users
+
+For better experience on Windows, install pyreadline3:
+```bash
+pip install pyreadline3
+```
+
+## What's New in v2.0
+
+### 🆕 Direct AI Assistant (`/ask`)
+- **Ask any question** directly to the AI without generating commands
+- **Perfect for learning** - get explanations, tutorials, and advice
+- **Context-aware responses** - AI understands your system environment
+- **Clean formatting** - Beautiful response display with visual separators
+
+### 🎨 Enhanced Visual Experience
+- **Colorful ASCII art logo** - Eye-catching Commandor branding on startup
+- **Rainbow color palette** - More vibrant and engaging interface
+- **Emoji indicators** - Visual cues for different actions (🤖, 🧠, 💡, etc.)
+- **Improved help system** - Better organized with examples for both features
+
+### 🚀 Better User Experience
+- **Clearer command distinction** - Visual separation between `/ai` and `/ask`
+- **Enhanced prompts** - More informative and colorful terminal prompts
+- **Improved error messages** - Better feedback with emoji indicators
+- **Professional presentation** - Polished interface that's both functional and beautiful
+
+## Contributing
+
+We welcome contributions from everyone! Here's how you can help:
+
+### Ways to Contribute
+- **Report bugs** by opening an issue
+- **Suggest features** or improvements
+- **Improve documentation**
+- **Submit pull requests** with bug fixes or new features
+- **Star the repository** to help others discover it
+
+### Development Setup
+
+1. **Fork and clone the repository:**
+   ```bash
+   git clone https://github.com/ravin-d-27/Commandor.git
+   cd commandor
+   ```
+
+2. **Install in development mode:**
+   ```bash
+   pip install -e .
+   ```
+
+3. **Make your changes and test:**
+   ```bash
+   commandor
+   ```
+
+4. **Submit a pull request**
+
+### Contribution Guidelines
+- Follow existing code style
+- Add tests for new features
+- Update documentation as needed
+- Be respectful and inclusive in discussions
+
+## License
+
+Commandor is **free and open source** for everyone! 🎉
+
+- ✅ **Personal use**: No attribution required
+- ✅ **Commercial use**: Free with attribution requirement
+- ✅ **Contributions**: Always welcome!
+- ✅ **Modifications**: Allowed with proper attribution
+
+### Commercial Attribution Requirement
+
+If you're using Commandor commercially, we just ask that you:
+- Display **"Powered by Commandor"** in your product
+- Include a link to this repository
+- Consider sharing your use case with the community
+
+See [LICENSE](LICENSE) for complete details.
+
+## Showcase
+
+**Using Commandor in your project?** We'd love to feature you! Submit your use case by opening an issue or contacting us.
+
+### Featured Users
+*Be the first to be featured here by using Commandor commercially and letting us know!*
+
+## Uninstallation
+
+To uninstall Commandor:
+
+```bash
+pip uninstall commandor
+```
+
+## Support & Contact
+
+- 🐛 **Issues**: [GitHub Issues](https://github.com/ravin-d-27/Commandor/issues)
+- 📧 **Email**: [ravin.d3107@outlook.com]
+- 💬 **Discussions**: [GitHub Discussions](https://github.com/ravin-d-27/Commandor/discussions)
+
+## Acknowledgments
+
+- Thanks to all contributors who help make Commandor better
+- Built with Google's Gemini AI
+- Inspired by the need for more intuitive terminal interactions
+
+---
+
+**If Commandor helps you, please star this repository to help others discover it!**
+
+**Made with ❤️ by Ravin D**