Eminds README

Overview

Eminds is a VS Code extension that enables code review for Python files. It allows users to review individual files or entire folders by sending them to a local review server. The reviewed files are then downloaded and displayed in VS Code.

Features

• Review a Single Python File: Select and review an individual .py file, and download the reviewed version.
• Review an Entire Folder: Select a folder containing Python files, and review all of them at once.
• Automatic Download & Open: Reviewed files are automatically downloaded and opened in VS Code.

Requirements

• A local server running at http://127.0.0.1:8000.
• Node.js and npm installed to build and run the extension.
• Required dependencies (axios, fs, path, vscode) installed.

Installation

1. Clone the repository.
2. Install dependencies:

   npm install
   

3. Run the extension in development mode:

   npm run watch:tsc
   

Usage

Review a Single File

1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS).
2. Search for and select Eminds: Review Code.
3. Choose a Python file to review.
4. The reviewed file will be downloaded and opened in VS Code.

Review a Folder

1. Open the Command Palette.
2. Search for and select Eminds: Review Folder.
3. Choose a folder containing Python files.
4. The reviewed folder will be opened in VS Code.

Extension Settings

This extension does not introduce any configurable settings at this time.

Known Issues

• The extension assumes that a review server is running locally at http://127.0.0.1:8000. If the server is not available, the review process will fail.
• Only Python files (.py) are currently supported.

Release Notes

1.0.0

• Initial release with support for reviewing individual Python files and entire folders.

Following Extension Guidelines

Ensure that you've read through the extension guidelines and follow the best practices for creating your extension.

• Extension Guidelines

Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

• Split the editor (Ctrl+\ on Windows and Linux, Cmd+\ on macOS).
• Toggle preview (Shift+Ctrl+V on Windows and Linux, Shift+Cmd+V on macOS).
• Press Ctrl+Space to see a list of Markdown snippets.

For More Information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference

Enjoy using Eminds!