bridgex 0.0.1.dev0__py3-none-any.whl

bridgex/logic/Converter.py

@@ -0,0 +1,33 @@
+from typing import Optional
+from pathlib import Path
+from ..models.Returning import Returning
+from markitdown import MarkItDown, DocumentConverterResult
+from chromologger import Logger as Log
+from threading import Thread
+import asyncio
+
+log = Log(f'{Path(__file__).parent.parent}/logs/log_converter.log') # Initialize logger
+
+class Converter(MarkItDown):
+    def __init__(self, filename:str, ep: Optional[bool] =None, eb: Optional[bool] =None) -> None:
+        super().__init__(enable_plugins=ep, enable_builtins=eb)
+        self.__fn:str = filename # Path to file + extension
+        self.content:str = ''
+
+    def convert_file(self) -> Returning:
+        __return:Returning = Returning(False)
+        try:
+            __thread:Thread = Thread(target=lambda: asyncio.run(self.__convert(__return)))
+            __thread.start()
+            __thread.join()
+        except Exception as e:
+            log.log_e(e)
+        return __return
+
+    async def __convert(self, __return) -> None:
+        #self.content = await asyncio.sleep(1, result=self.convert(self.__fn))
+        __converted: DocumentConverterResult = await asyncio.sleep(1, result=self.convert(self.__fn))  # Convert file
+        if __converted is not None:
+            __return.ok = True
+            __return.data_str = __converted.text_content
+            log.log(f'File "{self.__fn}" converted successfully')

bridgex/models/Returning.py

@@ -0,0 +1,14 @@
+from typing import Optional
+
+class Returning:
+    """To standardize function returns, you can add information in text format (String) or a dictionary (dict)"""
+    def __init__(self, ok:bool = True, data_str: Optional[str] = None, data_dict: Optional[str] = None):
+        """Class constructor
+
+        :param ok: Successful operation
+        :param data_str: String information
+        :param data_dict: Dictionary information
+        """
+        self.ok: bool = ok # Status (operation)
+        self.data_str: Optional[str] = data_str # String information
+        self.data_dict: Optional[dict] = data_dict # Dictionary information

bridgex/utils/FilesManager.py

@@ -0,0 +1,65 @@
+from chromologger import Logger
+from chromolog import Print as Log
+from pathlib import Path
+
+log = Logger(f'{Path(__file__).parent.parent}/logs/log_file_manager.log')
+p:Log = Log()
+
+class FileManager:
+    def __init__(self, filename:str | None = None, output:str | None = None, encoding:str='utf-8') -> None:
+        self.__fn:Path = Path(filename) # Path to file + extension
+        self.__ot:Path = Path(output) # Path to file output + extension
+        self.__en:str = encoding # Encoding to write a file .md
+        self.__validate()
+
+    def __validate(self) -> bool | None:
+        """Validate an extension file, and output existing"""
+        __allowed:bool = self.__fn.suffix.lower() in self.extensions()
+        __exists:bool = self.__fn.is_file()
+        __exists_dir:bool = self.__ot.is_dir()
+        if not __allowed:
+            raise TypeError(f'File extension ("{self.__fn.suffix.lower()}") not allowed')
+        if not __exists:
+            raise FileNotFoundError(f'File "{self.__fn.name}" not found')
+        if not __exists_dir:
+            raise NotADirectoryError(f'"{self.__ot.absolute()}" not found')
+        return True
+
+    def save_md(self, content:str) -> bool:
+        """Saves content a Markdown file
+
+        :param content: Content to save
+        :return: Value indicating whether the file was saved or not
+        """
+        __return:bool = False
+        __file_md:str = f'{self.dir_output}/{self.__fn.stem}.md'
+        try:
+            if type(content) is not str:
+                raise TypeError('The content must be a string')
+            with open(__file_md, 'w', encoding=self.__en) as __file:
+                __file.write(content)
+                log.log(f'File "{__file_md}" saved successfully')
+            __return = True
+        except Exception as Error:
+            log.log_e(Error)
+        return __return
+
+    @staticmethod
+    def extensions() -> list[str]: return  [".pdf", ".docx", ".pptx", ".xlsx", ".xls", ".msg", ".csv", ".txt", ".text",
+                                  ".md", ".markdown", ".json", ".jsonl", ".xml", ".rss", ".atom", ".html", ".mhtml",
+                                  ".htm", ".epub", ".zip", ".ipynb"]
+
+    @staticmethod
+    def read_file(filename:str = '', encoding:str = 'utf-8') -> str:
+        __return:str = ''
+        try:
+            with open(filename, 'r', encoding=encoding) as file:
+                __return = str(file.read())
+        except Exception as e:
+            log.log_e(e)
+        return __return
+
+    @property
+    def file(self) -> str: return self.__fn.resolve().__str__()
+    @property
+    def dir_output(self) -> str: return self.__ot.resolve().__str__()

bridgex-0.0.1.dev0.dist-info/METADATA

@@ -0,0 +1,193 @@
+Metadata-Version: 2.4
+Name: bridgex
+Version: 0.0.1.dev0
+Summary: graphical interface for converting files to Markdown, built in Python and based on PySide6 and Markitdown
+Author-email: dev2forge <bridgex@dev2forge.software>
+Maintainer-email: tutosrive <tutosrive@dev2forge.software>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Dev2Forge/bridgex
+Project-URL: Repository, https://github.com/Dev2Forge/bridgex
+Project-URL: Issues, https://github.com/Dev2Forge/bridgex/issues
+Keywords: markdown,converter,pyside6,gui,editor,viewer,pdf,docx,pptx,xls,xlsx,outlook,csv,txt,html,htm,file converter,markdown converter,markitdown,dev2forge,bridgex,microsoft office
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Utilities
+Classifier: Topic :: Text Processing :: Markup
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Environment :: X11 Applications :: Qt
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Environment :: MacOS X
+Requires-Python: <=3.13,>=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: markitdown[docx,outlook,pdf,pptx,xls,xlsx]==0.1.1
+Requires-Dist: chromologger==0.1.8
+Requires-Dist: PySide6-Essentials==6.9.0
+Requires-Dist: sqlazo==0.1.5
+Requires-Dist: chromolog==0.2.4
+Dynamic: license-file
+
+# Bridgex 🌉🐍
+
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+![Pepy Total Downloads](https://img.shields.io/pepy/dt/bridgex)
+[![PyPI version](https://img.shields.io/pypi/v/bridgex?label=bridgex)](https://pypi.org/project/bridgex/)
+[![Python Version](https://img.shields.io/badge/python-3.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-blue.svg)](https://www.python.org/downloads/)
+[![Issues](https://img.shields.io/github/issues/Dev2Forge/bridgex)](https://github.com/Dev2Forge/bridgex/issues)
+
+Bridgex is an open‑source graphical interface for converting files to Markdown, built in Python and based on [Pyside6 (Qt for Python)](https://doc.qt.io/qtforpython-6/). Its objective is to simplify access to the [Markitdown](https://github.com/microsoft/markitdown) library through a straightforward, modular visual experience.
+
+---
+
+## Table of Contents
+
+- [Bridgex 🌉🐍](#bridgex-)
+  - [Table of Contents](#table-of-contents)
+  - [Features](#features)
+  - [Screenshots](#screenshots)
+  - [Installation](#installation)
+  - [Local Cloning and Execution 💻](#local-cloning-and-execution-)
+  - [Basic Usage](#basic-usage)
+  - [Supported Formats](#supported-formats)
+  - [Limitations](#limitations)
+  - [Releases](#releases)
+  - [Dependencies and Licences](#dependencies-and-licences)
+  - [Contribute](#contribute)
+  - [Licence](#licence)
+
+---
+
+## Features
+
+* Cross‑platform graphical interface.
+* Efficient file‑to‑Markdown conversion.
+* Modularity: easy to adapt and extend.
+* Support for multiple input formats.
+* Lightweight editing prior to saving.
+
+---
+
+## Screenshots
+
+![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridgex/preview-1-main.png)
+*Example of Bridgex’s main window.*
+
+<details>
+<summary><strong>View interface previews</strong></summary>
+
+<br>
+
+|     Name     | Preview |
+|:----------------:|:---------------------:|
+| Open File | ![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridgex/preview-2-openfile.png) |
+| Mini Editor | ![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridgex/preview-3-minieditor.png) |
+| Convert | ![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridgex/preview-4-convert.png) |
+| Change Language | ![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridgex/preview-5-languagechange.png) |
+
+</details>
+
+---
+
+## Installation
+
+Requirements:
+
+* Python ≥ **3.9** and ≤ **3.13**
+
+Install via pip:
+
+```sh
+pip install bridgex
+```
+
+Start Bridgex from the terminal:
+
+```sh
+bridgex
+```
+
+It is recommended to use a virtual environment. To customise supported formats, edit the [`requirements.txt`](./requirements.txt) file as needed.
+
+---
+
+## Local Cloning and Execution 💻
+
+Clone the repository and run Bridgex locally:
+
+```sh
+git clone https://github.com/Dev2Forge/bridgex.git
+cd bridgex
+python -m venv .venv
+.venv\Scripts\activate  # On Windows
+# source .venv/bin/activate  # On Linux/MacOS
+pip install -r requirements.txt
+python -m src.bridgex
+```
+
+---
+
+## Basic Usage
+
+1. Run the application from the terminal or GUI.
+2. Select the file to convert.
+3. Review and edit the result if necessary.
+4. Save the file in Markdown format.
+
+---
+
+## Supported Formats
+
+Bridgex supports conversion of the following file formats:
+
+* PDF (`.pdf`)
+* Word (`.docx`)
+* PowerPoint (`.pptx`)
+* Excel (`.xlsx`, `.xls`, `.csv`)
+* Outlook Messages (`.msg`)
+* Text (`.txt`, `.text`)
+* Markdown (`.md`, `.markdown`)
+* JSON (`.json`, `.jsonl`)
+* XML (`.xml`)
+* RSS/Atom (`.rss`, `.atom`)
+* HTML/MHTML (`.html`, `.htm`, `.mhtml`)
+* ePub (`.epub`)
+* Compressed files (`.zip`)
+* Jupyter Notebooks (`.ipynb`)
+* Other formats supported by Markitdown
+
+---
+
+## Limitations
+
+Bridgex is not an IDE, text editor, Markdown editor, or document viewer. Its purpose is to serve as a bridgex between the user and Markdown conversion, offering lightweight editing without advanced editing features.
+
+---
+
+## Releases
+
+Check the published versions and release notes in the [Releases](https://github.com/Dev2Forge/bridgex/releases) section of the repository.
+
+---
+
+## Dependencies and Licences
+
+This project uses third‑party libraries, each with its own licence. See the [third‑party](./third-party/) folder for more information.
+
+---
+
+## Contribute
+
+Contributions are welcome. Please open an issue or pull request following the community’s best practices.
+
+---
+
+## Licence
+
+Distributed under the [MIT Licence](./LICENSE).
+
+©2025 Dev2Forge

bridgex-0.0.1.dev0.dist-info/RECORD

@@ -0,0 +1,48 @@
+bridgex/NOTICE,sha256=UCERvbyds4JS_GpcLq7ROol5SUgLco61GqIokfKBX7o,1695
+bridgex/__init__.py,sha256=6U7CMlm_xaQ-TmxU14ZBH3fpNXLXa5BOgAAzOZl-bBU,466
+bridgex/__main__.py,sha256=AiaxKrVu6kRxqRFJ-nMq5mibAtA5LRpIN3WPt-SgZww,109
+bridgex/_bridgex.py,sha256=O7cE70JM3f9Jychb2_y8pZm7PsCng-BfyRQexvPtavs,414
+bridgex/OSL/LICENSE_MARKITDOWN,sha256=W6oln_0al1eAhp19KSUhIiTJIgbO-5b7K_CxRmUOUCk,1160
+bridgex/OSL/LICENSE_PYSIDE6,sha256=LPNKwDiu5awG-TPd0dqYJuC7k4PBPY4LCI_O0LSpW1s,7814
+bridgex/OSL/url_licenses.srm,sha256=Dh8tdR5XpmOv8jG1_zegMEUIS5xshPpRNQg6PVnuyIg,187
+bridgex/database/Manager.py,sha256=4DFRRVo-XuLyl4T4B8ClkZ2VXYdovDwqctQe_0kDhKA,1080
+bridgex/database/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bridgex/interface/__init__.py,sha256=S-E8qM1fKlFO1PV_-QJmAvO7UvNPXvGOGf6kyroZ0YM,229
+bridgex/interface/_about.py,sha256=h8gIJKumgov6l1BJxe-mSI2uGkgPUxmsByVCBm5DCwg,807
+bridgex/interface/_initialHelp.py,sha256=Y-0tiLPjxB7FRfHMQPgZPLaIftMlcYgryaKPina4FEA,1413
+bridgex/interface/_interface.py,sha256=Q2mmorUIOM-yg7mgU2JK0zGJDdiNmuRw71TjRy47PDM,10150
+bridgex/interface/_lang.py,sha256=wFaCE0IYstuZY-nQWVX2N8CieLX6M0NO6_UP96vRU4Y,2286
+bridgex/interface/_osl.py,sha256=G1lMMGtwGIyCwX_5xKn6Py1bmPdUnZgZNlNKR3tB-FY,1484
+bridgex/interface/resources_rc.py,sha256=YxgB4RNhBFf9FE_etLLeYk9Y4OW_bh911OtttZ2wGBg,1711596
+bridgex/interface/ui_dialog_about.py,sha256=grAx6U3h5TJjE7X--pX0oLMFRAf1F92p-Cc_P-DVl0A,5058
+bridgex/interface/ui_dialog_language.py,sha256=kKz6D8da1In8un58WgJ2azaQzjxE8NKe5jPqAdYG5qI,5753
+bridgex/interface/ui_main_window.py,sha256=Z5TCebLE3zgSlExTYYiM9j3a6mD_d11wfaKcVXcJ4KA,31357
+bridgex/interface/ui_osl.py,sha256=HPSWwydIwVyjmlyn7XUaKiOHmF7fIdNyfePd6o8MYKE,6562
+bridgex/interface/assets/img/gh-logo.png,sha256=2D3fTqmOnS53hIhpy-Xw7KuzBY7eIsaBu-B7RakJGQk,8640
+bridgex/interface/assets/img/osl_icon.webp,sha256=FD1B7a_JEB4dcJ72slEY2OV6EmM75btJuYgaZikf4W4,8328
+bridgex/interface/assets/img/language/en_GB.svg,sha256=-9URqdMPAOuYuuEZ_RxiTlpcvukHiNgdDWh3WQxOYss,1966
+bridgex/interface/assets/img/language/es_CO.svg,sha256=ahwRqtFK4kw8505iITmzFW2K2Er35rX5OvVAtCBlgWQ,787
+bridgex/interface/assets/img/logo-bridgex/logo-bridgex-2.1.png,sha256=X-0afFfctufu_rhLfJdUP1rPJQbcD-W_ivoAUKU2TaE,187044
+bridgex/interface/assets/img/logo-bridgex/logo-bridgex-2.2.png,sha256=9E3QhzFtUjZ-ezLW2PU7hhq4rkbo9WKO2cxCpS91JjE,32941
+bridgex/interface/assets/img/logo-bridgex/logo-bridgex-2.png,sha256=9eEWA68WEdBEEBORPd5vXH87aXpFORVgwTy9Aq0LLbM,312673
+bridgex/interface/translations/locale/bridge_es_CO.qm,sha256=AQP5QNf2reUkHDYT28SjdNBKL1pEKbOljJywwSkb8EU,7206
+bridgex/interface/translations/locale/bridge_es_GB.qm,sha256=YNJd5nJ3Q1mglOjEQ1R5PQXsxvTE0X3jBFiBK1Y2eqQ,7024
+bridgex/interface/translations/others/ABOUT_en_GB.trg,sha256=mt7GC-kO68uRpbQP4njwESlj_JLJ0XHxIhsSTnYd0sI,3032
+bridgex/interface/translations/others/ABOUT_es_CO.trg,sha256=x88VR_AZE8bGde4d2KFVGBN9RKo6Q4bJ_bZ2WUslbOA,3081
+bridgex/interface/translations/others/IH_en_GB.srm,sha256=8p9nTuzR7DtzqEa7Nhp3gqtVBsCuWQ-4OauQ87eMxPM,551
+bridgex/interface/translations/others/IH_es_CO.srm,sha256=ntpykd377NU3F3g1N7lzA9LuPaStmCMR_CN0mzlv-GU,582
+bridgex/interface/translations/others/NOTICE_en_GB.srm,sha256=VHk3wkf02Kn268TORijC3KDzbg7G43nTxd-5qqMda7M,1691
+bridgex/interface/translations/others/NOTICE_es_CO.srm,sha256=AaeTOTb6dqpVTo6OwgQzk1OfM97l0nSXTOmTQmE5UC8,1821
+bridgex/logic/Converter.py,sha256=6NJCQA6qxQ3E2JykRKpTEjmHi9bPvJU3FtVpm-m1mIg,1406
+bridgex/logic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bridgex/logs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bridgex/models/Returning.py,sha256=wKhjtOjlKRua8AHPJAAO420J56pq6v91xBu5xMGr4UE,645
+bridgex/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bridgex/utils/FilesManager.py,sha256=ObqSvXEWK4swQOBFnOwIULJBVnHhK1tm4poM2cCP_ss,2720
+bridgex/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bridgex-0.0.1.dev0.dist-info/licenses/LICENSE,sha256=lQkqkmny-NvbX9VR5MNlqyHhyjgvqrcUVcCR2AdTBow,1087
+bridgex-0.0.1.dev0.dist-info/METADATA,sha256=kAsXwlFXOjjyrcrYy4oBLAFWlksYIm_fC0OKxLvEA8Y,6389
+bridgex-0.0.1.dev0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+bridgex-0.0.1.dev0.dist-info/entry_points.txt,sha256=jUkwrfr53o7lWsl0vFQZtLNMOwuCMyywF9DnAi0Yi14,50
+bridgex-0.0.1.dev0.dist-info/top_level.txt,sha256=P0i6qai2HUtJKI-TN8i-LI5U0THcl1KI0P7C8wuhrEI,8
+bridgex-0.0.1.dev0.dist-info/RECORD,,

bridgex-0.0.1.dev0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

bridgex-0.0.1.dev0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+bridgex = bridgex.__main__:main

bridgex-0.0.1.dev0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Dev2Forge
+
+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.

bridgex-0.0.1.dev0.dist-info/top_level.txt

@@ -0,0 +1 @@
+bridgex