Skip to content

Latest commit

 

History

History
202 lines (143 loc) · 4.52 KB

README.md

File metadata and controls

202 lines (143 loc) · 4.52 KB

RePrompt: A Context Generator

This app is to be used in conjunction with mckaywrigley's xml parser.

The RePrompt is a tool designed to create a comprehensive context file (repo-context.txt) for AI coding assistants like ChatGPT. The context file aggregates essential information from your repository, including an overview, directory tree, excluded and included files, highlighted file contents, and additional static sections like a to-do list.

Features

  • Streamlit Web App: Intuitive interface to select folders, configure file inclusions/exclusions, and generate the context file.
  • Context File Generation: Produces a repo-context.txt file tailored for AI assistants.
  • Configurable Directory Tree: Exclude specified directories and files from the context.
  • File Content Integration: Includes syntax-highlighted contents of key files.
  • Static Content Integration: Adds static sections from files such as overview.txt and to-do_list.txt.
  • Save & Load Configurations: Retain file inclusion/exclusion preferences for future sessions.
  • Default Exclusions: Automatically excludes common directories and files to avoid unnecessary content.

Prerequisites

Directory Structure

RePrompt/
├── src/
│   ├── app.py                   # Main Streamlit application
│   ├── generate_repo_context.py # Context generation script
│   ├── config.yaml             # Configuration file
│   ├── index.html            # The webpage file
│   └── requirements.txt        # Python dependencies

Installation

1. Clone the Repository

git clone https://github.com/PR0M3TH3AN/RePrompt
cd RePrompt

2. Set Up Virtual Environment

Windows:

# Create virtual environment
python -m venv venv

# Activate using Command Prompt
venv\Scripts\activate

macOS/Linux:

# Create virtual environment
python3 -m venv venv

# Activate
source venv/bin/activate

3. Install Dependencies

cd src

4. Install Dependencies

Update pip first:

python -m pip install --upgrade pip

pip install -r requirements.txt

Required packages:

streamlit
PyYAML
pyperclip

Running the Application

streamlit run app.py

The application will open in your default web browser at http://localhost:8501.

Usage

1. Initial Setup

  • There is a basic config.yaml file created for you in the src directory:
exclude_dirs:
  - node_modules
  - venv
  - __pycache__
  - .git
  - dist
  - build
  - logs
  - .idea
  - .vscode

important_files: []
custom_sections: []

2. Select Repository

  • Click "Choose Folder" in the sidebar
  • Navigate to your target repository
  • Select the folder

3. Configure Files

  • Select directories to include in the "Include in Directory Tree" section
  • Exclude specific files if needed
  • Review the "Final Included Files" list

4. Generate Context

  • Click "Generate Context File"
  • Download or copy the generated context
  • Save your configuration if desired

Customization

Modify Default Exclusions

Edit DEFAULT_EXCLUDED_DIRS and DEFAULT_EXCLUDED_FILES in app.py:

DEFAULT_EXCLUDED_DIRS = [
    "node_modules",
    "venv",
    "__pycache__",
    ".git",
    "dist",
    "build",
    "logs",
    ".idea",
    ".vscode"
]

DEFAULT_EXCLUDED_FILES = ["repo-context.txt"]

Troubleshooting

Common Issues

  1. Tcl_AsyncDelete Warning

    Tcl_AsyncDelete: async handler deleted by the wrong thread

    This warning can be safely ignored; it doesn't affect functionality.

  2. Permission Denied When Creating Directories

    • Run terminal/command prompt as administrator
    • Check folder permissions
    • Ensure you have write access to the installation directory

  3. Package Installation Failures

    # If pip install fails, try:
python -m pip install --upgrade pip
pip install -r requirements.txt

  4. Streamlit Port Already in Use

    • Kill any running Streamlit processes
    • Change the port:
    streamlit run app.py --server.port 8502

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. Push to the branch
  5. Open a Pull Request

License

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