Skip to content

QUICK_START.md

Latest commit

 

History

History
32 lines (22 loc) · 1.16 KB

QUICK_START.md

File metadata and controls

32 lines (22 loc) · 1.16 KB

Python Module Completion for Zsh

Intelligent tab completion for Python modules when using python -m commands.

Quick Start

# Clone the repository
git clone https://github.com/yourusername/zsh-python-module-completion.git ~/.zsh/zsh-python-module-completion

# Add to your .zshrc
echo "source ~/.zsh/zsh-python-module-completion/python-module-completion/python-module-completion.plugin.zsh" >> ~/.zshrc

# Reload your shell
source ~/.zshrc

# Enable local module completion in your Python project
cd /path/to/your/python/project
touch .local_module_completion

Note: Without the .local_module_completion file, the plugin uses zsh's default Python module completion. Create this file in your project root to enable local module scanning.

Features

  • ⚡ Immediate Completion: Works right after typing -m
  • 🔄 Hierarchical Navigation: Navigate nested modules seamlessly
  • 🎯 Smart Detection: Auto-detects Python projects and virtual environments
  • 🚀 Optimized Performance: Efficient module scanning with smart caching
  • 🔧 Configurable: Customize cache settings and behavior

For full documentation, see README.md