yamep 1.0.0__tar.gz

yamep-1.0.0/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024 tomsh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

yamep-1.0.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE
+recursive-include yamep/themes *
+recursive-include yamep/resources *

yamep-1.0.0/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.1
+Name: yamep
+Version: 1.0.0
+Summary: YAMEP - Yet Another Markdown Editor in Python
+Home-page: https://codeberg.org/tomsh/yamep
+Author: tomsh
+Author-email: tomsh@disroot.org
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PySide6
+Requires-Dist: markdown
+Requires-Dist: pymdown-extensions
+Requires-Dist: platformdirs
+
+
+# YAMEP
+
+YAMEP (Yet Another Markdown Editor in Python) is a lightweight and user-friendly markdown editor built with Python and PySide6. YAMEP offers a streamlined environment for writing and previewing markdown content with useful editing tools, live preview, and customizable themes.
+
+## Features
+
+- **Markdown Editing with Live Preview**: Write markdown in the editor with a real-time preview panel.
+- **Syntax Highlighting**: Inline code syntax highlighting to enhance readability.
+- **File Management**: Browse and open markdown files directly from the application.
+- **Theme Toggling**: Choose between light, dark, and blue themes for a comfortable editing experience.
+- **Task Lists**: Supports task lists with checkboxes in the preview.
+- **Easy-to-Use Interface**: Intuitive design with essential formatting buttons for markdown syntax.
+
+## Installation
+
+### Install on Arch Linux (via AUR)
+
+You can install YAMEP on Arch Linux through the Arch User Repository (AUR). If you use an AUR helper like `yay`, install with:
+
+```bash
+yay -S yamep
+```
+
+Or manually clone and build the package with:
+
+```bash
+git clone https://aur.archlinux.org/yamep.git
+cd yamep
+makepkg -si
+```
+
+### Install via `pipx` (Cross-Platform)
+
+To isolate YAMEP in its own environment using `pipx`, first ensure `pipx` is installed, then run:
+
+```bash
+pipx install yamep
+```
+
+### Manual Installation via Virtual Environment
+
+If you'd like to install YAMEP in a virtual environment, follow these steps:
+
+1. Clone the repository:
+   ```bash
+   git clone https://codeberg.org/tomsh/yamep.git
+   cd yamep
+   ```
+
+2. Create and activate a virtual environment:
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate  # On Windows, use .venv\Scripts\activate
+   ```
+
+3. Install YAMEP with `pip`:
+   ```bash
+   pip install .
+   ```
+
+4. Run YAMEP from the terminal:
+   ```bash
+   yamep
+   ```
+
+## Usage
+
+After installation, run `yamep` from the terminal or launch it from the Applications menu under **Utilities** (on supported desktop environments).
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

yamep-1.0.0/README.md

@@ -0,0 +1,73 @@
+
+# YAMEP
+
+YAMEP (Yet Another Markdown Editor in Python) is a lightweight and user-friendly markdown editor built with Python and PySide6. YAMEP offers a streamlined environment for writing and previewing markdown content with useful editing tools, live preview, and customizable themes.
+
+## Features
+
+- **Markdown Editing with Live Preview**: Write markdown in the editor with a real-time preview panel.
+- **Syntax Highlighting**: Inline code syntax highlighting to enhance readability.
+- **File Management**: Browse and open markdown files directly from the application.
+- **Theme Toggling**: Choose between light, dark, and blue themes for a comfortable editing experience.
+- **Task Lists**: Supports task lists with checkboxes in the preview.
+- **Easy-to-Use Interface**: Intuitive design with essential formatting buttons for markdown syntax.
+
+## Installation
+
+### Install on Arch Linux (via AUR)
+
+You can install YAMEP on Arch Linux through the Arch User Repository (AUR). If you use an AUR helper like `yay`, install with:
+
+```bash
+yay -S yamep
+```
+
+Or manually clone and build the package with:
+
+```bash
+git clone https://aur.archlinux.org/yamep.git
+cd yamep
+makepkg -si
+```
+
+### Install via `pipx` (Cross-Platform)
+
+To isolate YAMEP in its own environment using `pipx`, first ensure `pipx` is installed, then run:
+
+```bash
+pipx install yamep
+```
+
+### Manual Installation via Virtual Environment
+
+If you'd like to install YAMEP in a virtual environment, follow these steps:
+
+1. Clone the repository:
+   ```bash
+   git clone https://codeberg.org/tomsh/yamep.git
+   cd yamep
+   ```
+
+2. Create and activate a virtual environment:
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate  # On Windows, use .venv\Scripts\activate
+   ```
+
+3. Install YAMEP with `pip`:
+   ```bash
+   pip install .
+   ```
+
+4. Run YAMEP from the terminal:
+   ```bash
+   yamep
+   ```
+
+## Usage
+
+After installation, run `yamep` from the terminal or launch it from the Applications menu under **Utilities** (on supported desktop environments).
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

yamep-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

yamep-1.0.0/setup.py

@@ -0,0 +1,30 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='yamep',
+    version='1.0.0',
+    author='tomsh',
+    author_email='tomsh@disroot.org',
+    description='YAMEP - Yet Another Markdown Editor in Python',
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
+    url='https://codeberg.org/tomsh/yamep',
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=[
+        'PySide6',
+        'markdown',
+        'pymdown-extensions',
+        'platformdirs',
+    ],
+    entry_points={
+        'gui_scripts': [
+            'yamep = yamep.main:main',
+        ],
+    },
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+    ],
+    license='MIT',
+)

yamep-1.0.0/yamep/__init__.py

@@ -0,0 +1 @@
+# __init__.py

yamep-1.0.0/yamep/main.py

@@ -0,0 +1,20 @@
+import sys
+
+def main():
+    try:
+        from PySide6.QtWidgets import QApplication
+        from yamep.markdown_editor_app import MarkdownEditorApp
+
+        app = QApplication(sys.argv)
+        # Set the desktop file name (without the .desktop extension)
+        app.setDesktopFileName('yamep')
+        
+        markdown_editor_app = MarkdownEditorApp()
+        markdown_editor_app.show()
+        sys.exit(app.exec())
+    except Exception as e:
+        print(f"An error occurred: {e}")
+        sys.exit(1)
+
+if __name__ == '__main__':
+    main()