Skip to content

README.md

Latest commit

 

History

History
122 lines (88 loc) · 3.03 KB

README.md

File metadata and controls

122 lines (88 loc) · 3.03 KB

PyDevCheat

PyDevCheat Logo

Build Status License Python versions Version

Overview

PyDevCheat is a modern cheat sheet application that provides instant access to programming commands and snippets through both GUI and CLI interfaces. It combines multiple sources into one seamless experience:

PyDevCheat Screenshot

Features

  • 🔍 Real-time search across all sources
  • 🌙 Modern dark theme with syntax highlighting
  • 💻 Both GUI and CLI interfaces
  • 📱 Cross-platform support
  • 🔄 Offline mode with local caching

Installation

Prerequisites

  • Python 3.9 or higher
  • Git

Setup Instructions

  1. Clone the repository:
git clone https://github.com/elirancv/PyDevCheat.git
cd PyDevCheat
  1. Create and activate a virtual environment:
# Windows
python -m venv venv
venv\Scripts\activate

# Linux/macOS
python3 -m venv venv
source venv/bin/activate
  1. Install the package in development mode:
pip install -e .

Platform-Specific Dependencies

Linux (Ubuntu/Debian)

sudo apt-get install python3-pyqt6 python3-pyqt6-qt6

macOS

brew install pyqt@6

Windows

No additional steps required - dependencies are included in PyQt6 package.

Quick Start

GUI Mode

pydevcheat gui

CLI Mode

# Get cheat sheet for a command
pydevcheat cheat git commit

# Sync sources for offline use
pydevcheat sync

Keyboard Shortcuts

  • Ctrl/Cmd + F: Focus search
  • Esc: Clear search
  • Ctrl/Cmd + C: Copy content

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Built with ❤️ by Eliran Cohen