Aura Text Documentation

Installation

Aura Text currently supports Windows 10 x64 or later, with Linux and macOS ports in development.

Windows Installation

# Clone the repository
git clone https://github.com/rohankishore/Aura-Text.git
cd Aura-Text

# Create virtual environment (recommended)
python -m venv venv
venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Run Aura Text
python main.py

Quick Start

Get up and running with Aura Text in minutes

Creating Your First File

1. Launch Aura Text
2. Press Ctrl + N or go to File → New
3. Start typing your code
4. Save with Ctrl + S

Opening a Project

1. Go to File → Open Project as Treeview
2. Select your project folder
3. The project structure will appear in the sidebar
4. Click any file to open it

Editor Basics

Language Support

Aura Text automatically detects the language based on file extension. You can manually set the language from Preferences → Language menu.

Autocompletion

Start typing and suggestions will appear automatically. Press Tab or Enter to accept a suggestion.

Code Folding

Click the arrows in the left margin to collapse or expand code blocks.

File Management

Keyboard Shortcuts

Essential Shortcuts

View the complete list of shortcuts in Help → Keyboard Shortcuts

Git Integration

Aura Text provides comprehensive Git support for version control.

Cloning a Repository

1. Go to File → New Project from VCS
2. Enter the repository URL
3. Choose a local directory
4. Click Clone

Making Commits

1. Go to Git → Commit
2. Review your changes
3. Write a commit message
4. Click Commit

Pushing Changes

1. Go to Git → Push
2. Select the branch and remote
3. Click Push

Code Linting

Real-time code analysis helps catch errors as you type.

Enabling Linting

1. Go to Code → Enable Linter
2. Linting will start automatically for Python files
3. Errors and warnings appear with colored markers

Supported Linters

• pylint - Comprehensive Python linter
• flake8 - Style guide enforcement
• pyflakes - Lightweight error detection

Plugins

Extend Aura Text functionality with plugins

Installing Plugins

1. Go to File → Extensions
2. Browse available plugins
3. Click Download on any plugin
4. Restart Aura Text

Creating Custom Plugins

See the Plugin Development section for detailed instructions.

Plugin Development

Create your own plugins to add custom functionality

Basic Plugin Structure

from auratext.Core.plugin_interface import Plugin

class MyPlugin(Plugin):
    def __init__(self, window):
        super().__init__(window)
        self.name = "My Plugin"
        self.version = "1.0.0"
        
    def activate(self):
        # Plugin initialization code
        pass
        
    def deactivate(self):
        # Cleanup code
        pass

Adding Menu Items

from PyQt6.QtGui import QAction

class MyPlugin(Plugin):
    def __init__(self, window):
        super().__init__(window)
        # Add menu action
        action = QAction("My Action", window)
        action.triggered.connect(self.my_function)
        window.menuBar().addAction(action)
        
    def my_function(self):
        print("Plugin function called!")

Troubleshooting

Common Issues

Frequently Asked Questions