# PyEasyEdit
PyEasyEdit is a lightweight, feature-rich text editor built with PyQt6 and QScintilla. Designed to offer a flexible and efficient editing environment, PyEasyEdit supports syntax highlighting for multiple programming languages, file management capabilities, and customizable themes, making it an ideal choice for developers and writers alike.
<div align="center">
<img src="https://raw.githubusercontent.com/scottpeterman/pyeasyedit/main/screen-shots/main2.png" alt="PyEasyEdit" width="400px">
</div>
## Features
- **Syntax Highlighting**: Supports syntax coloring for Python, JavaScript, HTML, CSS, and more, making code easier to read and write.
- **Auto Completion**: Source code auto-completion
- **Code Folding**: Now you can collapse blocks of code
- **Jedi Support**: Auto-completion now includes improved jedi inspection (Python only), but this is still a work in progress.
- **Tab to space conversion**: Critical for python
- **File Management**: Open, edit, and save files with an intuitive interface. Recent files are tracked for quick access.
- **Search and Replace**: Powerful search and replace functionality to easily modify your documents.
- **Custom Dialogs**: Includes custom dialogs for searching, replacing, and more, enhancing the user experience.
- **Extensibility**: Designed with extensibility in mind, allowing for additional features and languages to be added.
## Getting Started via Pip
### Create a virtual env for Python:
```bash
md pyeasyedit
cd pyeasyedit
python -m venv venv
venv\Scripts\activate
pip install pyeasyedit
python -m pyeasyedit
```
## Getting Started From Source
### Prerequisites
Before you begin, ensure you have met the following requirements:
- Python 3.9 or later installed on your system.
- PyQt6 and QScintilla libraries installed. You can install these using pip:
```bash
pip install PyQt6 QScintilla
```
### Installation
Clone the repository to your local machine:
```bash
git clone git@github.com:scottpeterman/pyeasyedit.git
cd pyeasyedit
pip install -r requirements.txt
```
### Running PyEasyEdit
To start the editor, run the following command from the terminal:
```bash
python -m pyeasyedit
```
Optionally, you can specify a file to open directly:
```bash
python -m pyeasyedit /path/to/your/file.txt
```
## Usage
- **File Menu**: Use the File menu to open, save, or create new documents.
- **Edit Menu**: Access search and replace functions through the Edit menu.
- **Help Menu**: Contains the About dialog that provides information about the editor and a link to the project's GitHub page.
## License
PyEasyEdit is released under the GPLv3 License. See the LICENSE file for more information.
## Acknowledgments
- Special thanks to the PyQt and QScintilla teams for providing the powerful libraries that made this project possible.
- Learn more about PyQt and Qt at [Riverbank Computing](https://www.riverbankcomputing.com/) and [Qt Group](https://www.qt.io/), respectively.
```python
# Create a source distribution and a wheel, upload to pypi
python setup.py sdist bdist_wheel
twine upload dist/*
Raw data
{
"_id": null,
"home_page": "https://github.com/scottpeterman/pyeasyedit",
"name": "pyeasyedit",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Scott Peterman",
"author_email": "scottpeterman@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/92/9b/61a7a33b33c2de8187f69e6adbed7aa973b9bb215f70420a4d595a9935dc/pyeasyedit-0.1.22.tar.gz",
"platform": null,
"description": "# PyEasyEdit\r\n\r\nPyEasyEdit is a lightweight, feature-rich text editor built with PyQt6 and QScintilla. Designed to offer a flexible and efficient editing environment, PyEasyEdit supports syntax highlighting for multiple programming languages, file management capabilities, and customizable themes, making it an ideal choice for developers and writers alike.\r\n\r\n<div align=\"center\">\r\n <img src=\"https://raw.githubusercontent.com/scottpeterman/pyeasyedit/main/screen-shots/main2.png\" alt=\"PyEasyEdit\" width=\"400px\"> \r\n</div>\r\n\r\n## Features\r\n\r\n- **Syntax Highlighting**: Supports syntax coloring for Python, JavaScript, HTML, CSS, and more, making code easier to read and write.\r\n- **Auto Completion**: Source code auto-completion\r\n- **Code Folding**: Now you can collapse blocks of code\r\n- **Jedi Support**: Auto-completion now includes improved jedi inspection (Python only), but this is still a work in progress.\r\n- **Tab to space conversion**: Critical for python\r\n- **File Management**: Open, edit, and save files with an intuitive interface. Recent files are tracked for quick access.\r\n- **Search and Replace**: Powerful search and replace functionality to easily modify your documents.\r\n- **Custom Dialogs**: Includes custom dialogs for searching, replacing, and more, enhancing the user experience.\r\n- **Extensibility**: Designed with extensibility in mind, allowing for additional features and languages to be added.\r\n\r\n## Getting Started via Pip\r\n\r\n### Create a virtual env for Python:\r\n\r\n```bash\r\nmd pyeasyedit\r\ncd pyeasyedit\r\npython -m venv venv\r\nvenv\\Scripts\\activate\r\npip install pyeasyedit\r\npython -m pyeasyedit\r\n```\r\n\r\n## Getting Started From Source\r\n\r\n### Prerequisites\r\n\r\nBefore you begin, ensure you have met the following requirements:\r\n- Python 3.9 or later installed on your system.\r\n- PyQt6 and QScintilla libraries installed. You can install these using pip:\r\n\r\n ```bash\r\n pip install PyQt6 QScintilla\r\n ```\r\n\r\n### Installation\r\n\r\nClone the repository to your local machine:\r\n\r\n```bash\r\ngit clone git@github.com:scottpeterman/pyeasyedit.git\r\ncd pyeasyedit\r\npip install -r requirements.txt\r\n```\r\n\r\n### Running PyEasyEdit\r\n\r\nTo start the editor, run the following command from the terminal:\r\n\r\n```bash\r\npython -m pyeasyedit \r\n```\r\n\r\nOptionally, you can specify a file to open directly:\r\n\r\n```bash\r\npython -m pyeasyedit /path/to/your/file.txt\r\n```\r\n\r\n## Usage\r\n\r\n- **File Menu**: Use the File menu to open, save, or create new documents.\r\n- **Edit Menu**: Access search and replace functions through the Edit menu.\r\n- **Help Menu**: Contains the About dialog that provides information about the editor and a link to the project's GitHub page.\r\n\r\n\r\n## License\r\n\r\nPyEasyEdit is released under the GPLv3 License. See the LICENSE file for more information.\r\n\r\n## Acknowledgments\r\n\r\n- Special thanks to the PyQt and QScintilla teams for providing the powerful libraries that made this project possible.\r\n- Learn more about PyQt and Qt at [Riverbank Computing](https://www.riverbankcomputing.com/) and [Qt Group](https://www.qt.io/), respectively.\r\n\r\n```python\r\n# Create a source distribution and a wheel, upload to pypi\r\npython setup.py sdist bdist_wheel\r\ntwine upload dist/* \r\n\r\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "A PyQt6 multi-tabbed editor based on QScintilla, includes limited IDE functions via Jedi",
"version": "0.1.22",
"project_urls": {
"Homepage": "https://github.com/scottpeterman/pyeasyedit"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0bd679cf2ffe08cbedc54c9da831327a7a671e1cd3a8324d82cb9bc7da9a6b75",
"md5": "50c1c840baf0cc668ee4a3be19546056",
"sha256": "b6057c1b40c71fbf07f899ced1b005ede9b128f1c968debd43e3578fc0a45b1e"
},
"downloads": -1,
"filename": "pyeasyedit-0.1.22-py3-none-any.whl",
"has_sig": false,
"md5_digest": "50c1c840baf0cc668ee4a3be19546056",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2876910,
"upload_time": "2024-04-29T17:35:10",
"upload_time_iso_8601": "2024-04-29T17:35:10.895908Z",
"url": "https://files.pythonhosted.org/packages/0b/d6/79cf2ffe08cbedc54c9da831327a7a671e1cd3a8324d82cb9bc7da9a6b75/pyeasyedit-0.1.22-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "929b61a7a33b33c2de8187f69e6adbed7aa973b9bb215f70420a4d595a9935dc",
"md5": "1d5d1164035ec4ba49a423bdfb9f4c1f",
"sha256": "9737ba4ea1b4084ceffd69f42bdffd784de4889c0253a5dfbfdc66358c43fcce"
},
"downloads": -1,
"filename": "pyeasyedit-0.1.22.tar.gz",
"has_sig": false,
"md5_digest": "1d5d1164035ec4ba49a423bdfb9f4c1f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2879083,
"upload_time": "2024-04-29T17:35:14",
"upload_time_iso_8601": "2024-04-29T17:35:14.101281Z",
"url": "https://files.pythonhosted.org/packages/92/9b/61a7a33b33c2de8187f69e6adbed7aa973b9bb215f70420a4d595a9935dc/pyeasyedit-0.1.22.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 17:35:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scottpeterman",
"github_project": "pyeasyedit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pyeasyedit"
}