Table of Contents
-
About The Project
-
Getting Started
- Development
- Roadmap
- Contributing
- License
View the README In:
-
हिन्दी 🇮🇳
-
Deutsch
- Español
- தமிழ் 🇮🇳
- Français
- 日本語
- Português
- Русский
- 简体中文
About The Project
Aura Text is an excellent text/code editor that offers a wide array of essential tools. Built with PyQt6 and Python, it harnesses the power and flexibility of these technologies.
With Aura Text, users can access a versatile and powerful editing environment. Whether working on a small script or a complex project, Aura Text equips you with all the necessary features to streamline your workflow. From syntax highlighting and code completion to smart indentation and advanced terminal, Aura Text ensures that your coding experience is efficient and enjoyable while being extremely light on your PC.
The main highlights of Aura Text are:
- Edit files (duh)
- Support up to 30 languages
- Autocompletion with intelligent quote and string matcher
- Code Linting for Python (BETA) (More langs coming soon)
- Git Clone, Commit and Push with interactive rebase and graphs
- Command Palette for quick execution of tasks
- Custom title bars
- Regex Playground
- Split pane Markdown editor
- Terminal with history
- Python Console
- Plugin support
- Extensive theming including Material Theming support
- Extremely customisable (like literally you can change every aspect of it)
Getting Started
Let’s set up Aura Text on your PC!
Prerequisites
- Windows 10 x64 or later, a Linux distro running kernel 6.x or later, or macOS Ventura or later
- Python 3.9 or later
- Python installation is bootstrapped with pip
- (Necessary because you DO NOT want to screw up your primary Python installation) A fresh venv created with
python -m venv venv and activated with venv\Scripts\activate
- The contents of
requirements.txt installed via python[3] -m pip install -r requirements.txt
- (If building an installer) Inno Setup 6.4.3 or later
Installation
You can download a prebuilt installer from the Releases or build one yourself. If using prebuilt installers, just skip to the use section.
Building the installer
- Clone the repo or download a tarball
- Install all prerequisites
python build.py to compile the program first- Open up the
.iss Inno Setup script and compile it via Ctrl+F9 or Build > Compile - installer can be found in Output folder
Using the installer
Just run the .exe file, duh.
Testing
This is for people who solely just want to run without installation for mostly testing purposes.
We need the prerequisites above. After getting them, you can run the program with pythonw main.py to run it without flooding your terminal with logging, or you can just run with python main.py to troubleshoot errors and debug it.
Development
Roadmap
Make a status bar at the bottom with features similar to PyCharm or other IDEs (Read-only toggle, breadcrumbs, etc) Custom Theming Key Emulation Split Editing - Project Manager
Python Code Linting
and much much more…
Contributing
Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag “enhancement”.
Don’t forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature)
- Commit your Changes (
git commit -m 'Add some AmazingFeature')
- Push to the Branch (
git push origin feature/AmazingFeature)
- Open a Pull Request
Contributors
As Featured On
License
Distributed under the MIT License. See LICENSE.txt for more information.
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)
评论