PyEditor is a modern terminal-based text editor implemented in Python. It combines the simplicity of Nano with powerful, IDE-style features, all within a console environment. PyEditor utilizes the curses library for efficient screen management and Pygments for real-time syntax highlighting across various programming languages. Users can enjoy a streamlined editing experience that enhances productivity.
- Terminal-Based Interface: Works seamlessly in any terminal.
- Syntax Highlighting: Supports multiple languages with real-time highlighting using Pygments.
- Easy Navigation: Simple keyboard shortcuts for quick access to functions.
- File Management: Open, save, and edit files with ease.
- Search Functionality: Quickly find text within your files.
- Plugin Support: Extend functionality with user-defined plugins.
- Customizable Key Bindings: Adapt the editor to your workflow.
- Cross-Platform: Runs on Linux, macOS, and Windows.
To install PyEditor, you need to have Python 3.x installed on your system. Follow these steps:
-
Clone the Repository:
git clone https://github.com/marco71giusti/PyEditor.git
-
Navigate to the Directory:
cd PyEditor -
Install Required Packages: Use pip to install the necessary packages:
pip install -r requirements.txt
-
Run the Editor: You can now run PyEditor with the following command:
python pyeditor.py
-
Download Releases: For the latest stable version, download the releases here and execute the appropriate file for your operating system.
Once you have installed PyEditor, you can start using it right away. Here are some basic commands to get you started:
-
Open a File:
python pyeditor.py filename.txt
-
Save a File: Press
Ctrl + Sto save your current work. -
Search for Text: Press
Ctrl + F, then type the text you want to find. -
Close the Editor: Press
Ctrl + Qto exit.
You can customize PyEditor by editing the configuration file located in the .pyeditor directory in your home folder. Here are some options you can modify:
- Key Bindings: Change keyboard shortcuts to suit your preferences.
- Theme: Choose from several themes for syntax highlighting.
- Plugins: Enable or disable plugins as needed.
We welcome contributions from the community! If you want to help improve PyEditor, please follow these steps:
- Fork the Repository: Click on the "Fork" button on the top right corner of the repository page.
- Create a Branch:
git checkout -b feature/YourFeatureName
- Make Your Changes: Implement your feature or fix.
- Commit Your Changes:
git commit -m "Add Your Feature" - Push to Your Fork:
git push origin feature/YourFeatureName
- Create a Pull Request: Go to the original repository and click on "New Pull Request."
This project is licensed under the MIT License. See the LICENSE file for more details.
If you encounter any issues or have questions, please check the Releases section for updates. You can also open an issue in the repository for support.
- Documentation: Comprehensive documentation is available in the
docsfolder. - Examples: Explore the
examplesdirectory for sample configurations and plugins. - Community: Join our community on GitHub Discussions for tips and tricks.
Q: What platforms does PyEditor support?
A: PyEditor runs on Linux, macOS, and Windows.
Q: Can I use PyEditor for large projects?
A: Yes, PyEditor is designed to handle files of various sizes efficiently.
Q: Is there a way to extend PyEditor?
A: Yes, you can create plugins to add new features.
Q: How can I report a bug?
A: Open an issue in the repository and provide details about the bug.
- Thanks to the contributors who have helped improve PyEditor.
- Special thanks to the creators of the
cursesandPygmentslibraries for their invaluable tools.
This README provides a comprehensive overview of PyEditor. For any additional information or support, please feel free to reach out through the GitHub repository.