igntui 0.0.0__tar.gz

igntui-0.0.0/PKG-INFO

@@ -0,0 +1,425 @@
+Metadata-Version: 2.4
+Name: igntui
+Version: 0.0.0
+Summary: Interactive Terminal User Interface for GitIgnore template generation
+Keywords: gitignore,tui,terminal,git,templates,cli
+Author: Mohammad Abu Mattar
+Author-email: Mohammad Abu Mattar <mohammad.khaled@outlook.com>
+License-Expression: GPL-3.0-or-later
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console :: Curses
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Topic :: Terminals
+Classifier: Topic :: Utilities
+Requires-Dist: urllib3>=2.0.0
+Requires-Dist: windows-curses>=2.4.1 ; sys_platform == 'win32'
+Requires-Dist: pyfiglet>=1.0.2
+Requires-Dist: pytest>=7.0.0 ; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0 ; extra == 'dev'
+Requires-Dist: pytest-mock>=3.10.0 ; extra == 'dev'
+Requires-Dist: black>=23.0.0 ; extra == 'dev'
+Requires-Dist: hatch>=1.8.0 ; extra == 'dev'
+Requires-Dist: isort>=5.12.0 ; extra == 'dev'
+Requires-Dist: mypy>=1.0.0 ; extra == 'dev'
+Requires-Dist: ruff>=0.1.0 ; extra == 'dev'
+Requires-Dist: flake8>=6.0.0 ; extra == 'dev'
+Requires-Dist: pre-commit>=3.0.0 ; extra == 'dev'
+Requires-Dist: pytest>=7.0.0 ; extra == 'test'
+Requires-Dist: pytest-cov>=4.0.0 ; extra == 'test'
+Requires-Dist: pytest-mock>=3.10.0 ; extra == 'test'
+Requires-Dist: responses>=0.23.0 ; extra == 'test'
+Requires-Dist: windows-curses>=2.4.1 ; sys_platform == 'win32' and extra == 'windows'
+Maintainer: Mohammad Abu Mattar
+Maintainer-email: Mohammad Abu Mattar <mohammad.khaled@outlook.com>
+Requires-Python: >=3.9
+Project-URL: Documentation, https://github.com/MKAbuMattar/igntui/blob/main/Module/Utility/GitIgnore/igntui/README.md
+Project-URL: Homepage, https://github.com/MKAbuMattar/igntui
+Project-URL: Issues, https://github.com/MKAbuMattar/igntui/issues
+Project-URL: Repository, https://github.com/MKAbuMattar/igntui
+Provides-Extra: dev
+Provides-Extra: test
+Provides-Extra: windows
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# igntui
+
+<div align="center">
+  <a href="https://github.com/MKAbuMattar/igntui" target="_blank" rel="noreferrer">
+    <img src="https://img.shields.io/badge/github-%23181717.svg?style=for-the-badge&logo=github&logoColor=white" alt="GitHub Repository"/>
+  </a>
+
+  <a href="https://github.com/MKAbuMattar/igntui/releases" target="_blank" rel="noreferrer">
+    <img alt="GitHub Release" src="https://img.shields.io/github/v/release/MKAbuMattar/igntui?color=%232563eb&label=Latest%20Release&style=for-the-badge&logo=github" />
+  </a>
+
+  <a href="https://pypi.org/project/igntui/" target="_blank" rel="noreferrer">
+    <img src="https://img.shields.io/pypi/v/igntui?style=for-the-badge&logo=pypi&logoColor=white&color=2563eb&label=PyPI" alt="PyPI Version"/>
+  </a>
+
+  <a href="https://pypi.org/project/igntui/" target="_blank" rel="noreferrer">
+    <img src="https://img.shields.io/pypi/pyversions/igntui?style=for-the-badge&logo=python&logoColor=white&color=2563eb&label=Python" alt="Python Versions"/>
+  </a>
+
+  <a href="/LICENSE" target="_blank" rel="noreferrer">
+    <img alt="GPL-3.0 License" src="https://img.shields.io/github/license/MKAbuMattar/igntui?color=%232563eb&style=for-the-badge&label=License">
+  </a>
+
+  <a href="https://github.com/MKAbuMattar/igntui/stargazers" target="_blank" rel="noreferrer">
+    <img alt="GitHub Stars" src="https://img.shields.io/github/stars/MKAbuMattar/igntui?color=%232563eb&label=Stars&style=for-the-badge&logo=github">
+  </a>
+
+  <a href="https://pypi.org/project/igntui/" target="_blank" rel="noreferrer">
+    <img alt="PyPI Downloads" src="https://img.shields.io/pypi/dm/igntui?color=%232563eb&style=for-the-badge&logo=pypi&label=Downloads">
+  </a>
+
+  <a href="https://github.com/MKAbuMattar/igntui/issues" target="_blank" rel="noreferrer">
+    <img alt="GitHub Issues" src="https://img.shields.io/github/issues/MKAbuMattar/igntui?color=%232563eb&style=for-the-badge&logo=github&label=Issues">
+  </a>
+</div>
+
+<br/>
+
+[🌐 Website](https://mkabumattar.com/) • [📦 PyPI](https://pypi.org/project/igntui/) • [🚀 Quick Start](#-installation) • [💬 Support](https://github.com/MKAbuMattar/igntui/issues)
+
+<br/>
+
+---
+
+> A powerful Terminal User Interface (TUI) and CLI for generating `.gitignore` files from [gitignore.io](https://www.toptal.com/developers/gitignore) templates.
+
+</div>
+
+## ✨ Features
+
+### 🎨 Interactive TUI Mode
+
+- **Smart Search** - Fuzzy, exact, and regex search modes (F1/F2/F3)
+- **Multi-Template Selection** - Select and combine multiple templates
+- **Live Preview** - See generated `.gitignore` content in real-time
+- **Intuitive Navigation** - Tab between panels, arrow keys, vim-style shortcuts
+- **Beautiful Interface** - Animated splash screen with pyfiglet ASCII art
+
+### ⚡ Performance
+
+- **Intelligent Caching** - Local template caching for instant access
+- **Async Loading** - Non-blocking template loading and generation
+- **Rate Limiting** - Respects API limits automatically
+
+### 💾 Export & Save
+
+- **Save to File** - Save generated `.gitignore` with custom paths
+- **Export Templates** - Export selected templates as JSON
+- **Overwrite Protection** - Confirmation dialogs for existing files
+
+### 🛠️ CLI Mode
+
+- **Quick Generation** - Generate `.gitignore` from command line
+- **List Templates** - Browse 571+ available templates
+- **Test Connection** - Verify API connectivity
+- **Cache Management** - Clear and manage local cache
+
+## 📦 Installation
+
+### Using pip (Standard)
+
+```bash
+pip install igntui
+```
+
+### Using pipx (Isolated)
+
+[pipx](https://pipx.pypa.io/) installs the package in an isolated environment:
+
+```bash
+pipx install igntui
+```
+
+### From source
+
+```bash
+git clone https://github.com/MKAbuMattar/igntui.git
+cd igntui
+pip install -e .
+```
+
+### Windows Requirements
+
+On Windows, you'll need the `windows-curses` package:
+
+```bash
+pip install windows-curses
+```
+
+## 🚀 Quick Start
+
+### Launch TUI (Interactive Mode)
+
+```bash
+igntui
+```
+
+or
+
+```bash
+python -m igntui
+```
+
+### CLI Commands
+
+#### Generate `.gitignore`
+
+```bash
+# Single template
+igntui generate python
+
+# Multiple templates
+igntui generate python node visualstudiocode
+
+# Save to file
+igntui generate python --output .gitignore
+```
+
+#### List Available Templates
+
+```bash
+# List all templates
+igntui list
+
+# Search templates
+igntui list --search python
+
+# Show count only
+igntui list --count
+```
+
+#### Test API Connection
+
+```bash
+igntui test
+```
+
+#### Cache Management
+
+```bash
+# Show cache info
+igntui cache --info
+
+# Clear cache
+igntui cache --clear
+```
+
+#### Show Version
+
+```bash
+igntui --version
+# Output: igntui/1.0.0 Python/3.13.0 Windows/11
+```
+
+## 🎮 TUI Usage
+
+### Keyboard Shortcuts
+
+#### Navigation
+
+- `Tab` / `Shift+Tab` - Navigate between panels
+- `↑` / `↓` - Move selection up/down
+- `PgUp` / `PgDn` - Page up/down
+- `Home` / `End` - Jump to top/bottom
+
+#### Search Modes
+
+- `F1` - Fuzzy search (default)
+- `F2` - Exact search
+- `F3` - Regex search
+
+#### Template Management
+
+- `Space` - Select/deselect template
+- `a` - Select all templates
+- `x` - Clear all selections
+- `Enter` - Generate `.gitignore` content
+
+#### Actions
+
+- `s` - Save generated `.gitignore` to file
+- `e` - Export selected templates as JSON
+- `F5` - Refresh template list
+- `h` / `?` - Show help dialog
+- `i` - Show app info
+- `q` / `Esc` - Quit application
+
+### Panel Layout
+
+```
+┌─────────────────────────────┬──────────────────────────────────┐
+│  Search Panel               │  Generated Content Panel         │
+│  (Filter templates)         │  (Preview .gitignore)            │
+├─────────────────────────────┤                                  │
+│  Available Templates        │                                  │
+│  (571+ templates)           │                                  │
+│                             │                                  │
+│  • Select with Space        │                                  │
+│  • Multi-select support     │                                  │
+│  • Smart search             │                                  │
+├─────────────────────────────┴──────────────────────────────────┤
+│  Selected Templates (Bottom Panel)                             │
+│  • Shows your current selection                                │
+│  • Remove with Space                                           │
+└────────────────────────────────────────────────────────────────┘
+│  Status Bar                                                    │
+│  • Keyboard shortcuts • Current mode • Status messages         │
+└────────────────────────────────────────────────────────────────┘
+```
+
+## 🎯 Use Cases
+
+### For Developers
+
+```bash
+# Python project
+igntui generate python venv
+
+# Node.js project
+igntui generate node npm yarn
+
+# Full-stack project
+igntui generate python node react visualstudiocode
+
+# Unity game development
+igntui generate unity visualstudio windows
+```
+
+### For Teams
+
+```bash
+# Export team's template selection
+igntui  # Select templates in TUI, press 'e' to export
+
+# Share the JSON file with team
+# Others can import and use the same templates
+```
+
+## ⚙️ Configuration
+
+Configuration file location: `~/.igntui.json`
+
+### Default Configuration
+
+```json
+{
+  "api": {
+    "base_url": "https://www.toptal.com/developers/gitignore/api",
+    "timeout": 10,
+    "cache_ttl": 3600,
+    "retry_attempts": 3
+  },
+  "ui": {
+    "theme": "default",
+    "mouse_support": true,
+    "animation_speed": 150
+  },
+  "behavior": {
+    "fuzzy_search_threshold": 0.6,
+    "max_recent_templates": 10
+  }
+}
+```
+
+## 🧪 Development
+
+### Setup Development Environment
+
+```bash
+# Clone repository
+git clone https://github.com/MKAbuMattar/igntui.git
+cd igntui
+
+# Install dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Format code
+black src/igntui
+isort src/igntui
+
+# Type checking
+mypy src/igntui
+```
+
+### Running Tests
+
+```bash
+# All tests
+pytest
+
+# With coverage
+pytest --cov=igntui
+
+# Specific test file
+pytest tests/test_api.py
+```
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## 📝 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 👨‍💻 Author
+
+**Mohammad Abu Mattar**
+
+- GitHub: [@MKAbuMattar](https://github.com/MKAbuMattar)
+- Website: [MKAbuMattar.com](https://mkabumattar.com)
+- Email: info@mkabumattar.com
+
+## 🙏 Acknowledgments
+
+- [gitignore.io](https://www.toptal.com/developers/gitignore) - Template source
+- [pyfiglet](https://github.com/pwaller/pyfiglet) - ASCII art generation
+- [Python curses](https://docs.python.org/3/library/curses.html) - Terminal UI framework
+
+## 📊 Statistics
+
+- **571+ Templates** - Comprehensive template library
+- **Smart Caching** - Reduces API calls by 90%
+- **3 Search Modes** - Fuzzy, exact, and regex
+- **Multi-select** - Combine unlimited templates
+- **Cross-platform** - Windows, macOS, Linux
+
+## 🔗 Links
+
+- **Repository**: https://github.com/MKAbuMattar/igntui
+- **Issue Tracker**: https://github.com/MKAbuMattar/igntui/issues
+- **PyPI Package**: https://pypi.org/project/igntui/
+- **Documentation**: https://github.com/MKAbuMattar/igntui/wiki (coming soon)
+
+---
+
+<div align="center">
+  <strong>Made with ❤️ by Mohammad Abu Mattar</strong>
+  <br>
+  <sub>Give it a ⭐ if you like it!</sub>
+</div>