From da245aa5ec0e714fd190a39fd5cf81be27984cc6 Mon Sep 17 00:00:00 2001 From: tutosrive Date: Sat, 28 Jun 2025 19:09:46 -0500 Subject: [PATCH 1/2] Update links to pyside6 --- README.md | 2 +- third-party/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4c75611..0c75886 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Because is easy to remember, easy to pronounce and because the program idea is b ## Third-Party Libraries -This project utilises third-party libraries, each with its own licence. Detailed information regarding these licences can be found in the [third-party](./third-party/) folder. +This project uses third-party libraries, each with its own licence. Detailed information regarding these licences can be found in the [third-party](./third-party/) folder. --- diff --git a/third-party/README.md b/third-party/README.md index 95a326d..fe733a5 100644 --- a/third-party/README.md +++ b/third-party/README.md @@ -30,7 +30,7 @@ SOFTWARE # Pyside6 -This project uses the [Pyside6](https://github.com/qtproject/pyside-pyside-setup/blob/dev/LICENSES/LGPL-3.0-only.txt) library for its GUI components. The Pyside6 library is licensed under the LGPL-3.0-only License. +This project uses the [Pyside6](https://doc.qt.io/qtforpython-6/) library for its GUI components. The Pyside6 library is licensed under the [LGPL-3.0-only License](https://github.com/qtproject/pyside-pyside-setup/blob/dev/LICENSES/LGPL-3.0-only.txt). ```LICENSE GNU LESSER GENERAL PUBLIC LICENSE From e433ebd8ac9b47c116eff53f1b6c264c6647df72 Mon Sep 17 00:00:00 2001 From: tutosrive Date: Sat, 28 Jun 2025 21:55:44 -0500 Subject: [PATCH 2/2] Add update README files, add file in spanish, missing content in both files! --- README.md | 152 +++++++++++++++++++++++++++++++------ translations/README_ES.md | 154 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 284 insertions(+), 22 deletions(-) create mode 100644 translations/README_ES.md diff --git a/README.md b/README.md index 0c75886..4903e30 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,152 @@ # Bridge 🌉🐍 -> [!NOTE] -> - Use external libraries to run, yo can see the Licenses for each -> - Is ready to use as module project (Relative paths) -> - The interface was made with [Pyside6 | Qt6 v6.9.0](https://doc.qt.io/qtforpython-6/), so, yo can modify the [.ui](https://doc.qt.io/qtforpython-6/tutorials/basictutorial/uifiles.html) files -> - Installable via [pip](https://pypi.org/project/pip/) -> - If you only need to convert one file type, yo can modify the [`requirements` file](./requirements.txt) adn put you file type (If [markitdown](https://github.com/microsoft/markitdown) provide it file type) +[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE) +[![PyPI version](https://img.shields.io/pypi/v/bridge-md.svg)](https://pypi.org/project/bridge-md/) +[![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/bridge)](https://github.com/Dev2Forge/bridge/issues) -> [!WARNING] -> - Isn't a IDE, is a Converter Program -> - The installation time can be slow, keep in mind that you can convert a great variety of files +Bridge 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. -**Bridge** is a 'Visual _Bridge_' between the [`general-users 🙆🏻‍♂️🙆🏻‍♀️`, `devs 👩🏻‍💻`] and the [**Markitdown**](https://github.com/microsoft/markitdown) library that allows convert a great variety of files to markdown format, which is very used around world, is so easy understand it and is very easy to write it! +--- + +## Table of Contents + +- [Bridge 🌉🐍](#bridge-) + - [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/bridge/preview-1-main.png) +*Example of Bridge’s main window.* + +
+View interface previews + +
+ +| Name | Preview | +| :-----: |:---: | +| Open File | ![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridge/preview-2-openfile.png) | +| Mini Editor | ![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridge/preview-3-minieditor.png) | +| Convert | ![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridge/preview-4-convert.png) | +| Change Language | ![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridge/preview-5-languagechange.png) | + +
+ +--- + +## Installation + +Requirements: + +* Python ≥ **3.9** and ≤ **3.13** + +Install via pip: -```shell +```sh pip install bridge ``` -## Why Bridge +It is recommended to use a virtual environment. To customise supported formats, edit the [`requirements.txt`](./requirements.txt) file as needed. -Because is easy to use, is a Python GUI (Thanks to [Pyside6(Qt For Python)](https://doc.qt.io/qtforpython-6/)) +--- + +## Local Cloning and Execution 💻 + +Clone the repository and run Bridge locally: + +```sh +git clone https://github.com/Dev2Forge/bridge.git +cd bridge +python -m venv .venv +.venv\Scripts\activate # On Windows +# source .venv/bin/activate # On Linux/MacOS +pip install -r requirements.txt +python -m src.bridge +``` + +--- + +## 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 + +Bridge 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 -## Why this name (Bridge)? +Bridge is not an IDE, text editor, Markdown editor, or document viewer. Its purpose is to serve as a bridge between the user and Markdown conversion, offering lightweight editing without advanced editing features. -Because is easy to remember, easy to pronounce and because the program idea is based in a "Bridge" between the users and the [**Markitdown**](https://github.com/microsoft/markitdown) library for python, easy to use, with graphic interface, just that 😁. +--- + +## Releases -## What's Bridge? +Check the published versions and release notes in the [Releases](https://github.com/Dev2Forge/bridge/releases) section of the repository. -**Bridge** is a **File Converter**, allow a great variety of files such as Power Point (**.pptx**), Word (**.docx**), PDF, Electronics Publications (**.epub**), Compressed files (**.zip**) and other files are allowed to convert. +--- -## What isn't Bridge? +## Dependencies and Licences -**Bridge** isn't a _IDE_, text editor, _markdown editor_, document viewer. The interface provided is just a **Lite Preview** where you can **edit** the incorrect formats before save the **Markdown File**. +This project uses third‑party libraries, each with its own licence. See the [third‑party](./third-party/) folder for more information. --- -## Third-Party Libraries +## Contribute -This project uses third-party libraries, each with its own licence. Detailed information regarding these licences can be found in the [third-party](./third-party/) folder. +Contributions are welcome. Please open an issue or pull request following the community’s best practices. --- -[©2025 Dev2Forge - MIT License](./LICENSE) \ No newline at end of file +## Licence + +Distributed under the [MIT Licence](./LICENSE). + +©2025 Dev2Forge diff --git a/translations/README_ES.md b/translations/README_ES.md new file mode 100644 index 0000000..dc2a7e6 --- /dev/null +++ b/translations/README_ES.md @@ -0,0 +1,154 @@ +# Bridge 🌉🐍 + +[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE) +[![PyPI version](https://img.shields.io/pypi/v/bridge-md.svg)](https://pypi.org/project/bridge-md/) +[![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/bridge)](https://github.com/Dev2Forge/bridge/issues) + +Bridge es una interfaz gráfica de código abierto para la conversión de archivos a formato Markdown, construida en Python y basada en [Pyside6 (Qt for Python)](https://doc.qt.io/qtforpython-6/). Su objetivo es facilitar el acceso a la biblioteca [Markitdown](https://github.com/microsoft/markitdown) mediante una experiencia visual sencilla y modular. + +--- + +## Tabla de Contenidos + +- [Bridge 🌉🐍](#bridge-) + - [Tabla de Contenidos](#tabla-de-contenidos) + - [Características ✨](#características-) + - [Capturas de Pantalla 🖼️](#capturas-de-pantalla-️) + - [Instalación 📦](#instalación-) + - [Clonación y Ejecución Local 💻](#clonación-y-ejecución-local-) + - [Uso Básico 🚀](#uso-básico-) + - [Formatos Soportados 📂](#formatos-soportados-) + - [Limitaciones ⚠️](#limitaciones-️) + - [Releases 🏷️](#releases-️) + - [Dependencias y licencias 📚](#dependencias-y-licencias-) + - [Contribuir 🤝](#contribuir-) + - [Licencia 📄](#licencia-) + +--- + +## Características ✨ + +- Interfaz gráfica multiplataforma. +- Conversión de archivos a Markdown de forma eficiente. +- Modularidad: fácil de adaptar y extender. +- Soporte para múltiples formatos de entrada. +- Edición ligera previa al guardado. + +--- + +## Capturas de Pantalla 🖼️ + +![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridge/preview-1-main.png) +_Ejemplo de la ventana principal de Bridge._ + +
+Ver previsualizaciones de interfaz + +
+ +| Nombre | Vista Previa | +|:----------------:|:---------------------:| +| Abrir Archivo | ![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridge/preview-2-openfile.png) | +| Mini Editor | ![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridge/preview-3-minieditor.png) | +| Convertir | ![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridge/preview-4-convert.png) | +| Cambiar Idioma | ![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridge/preview-5-languagechange.png) | + +
+ + + + + +--- + +## Instalación 📦 + +Requisitos: +- Python >= **3.9** Y <= **3.13** +Instalación vía pip: + +```sh +pip install bridge +``` + +Se recomienda el uso de un entorno virtual. Para personalizar los formatos soportados, edite el archivo [`requirements.txt`](../requirements.txt) según sus necesidades. + +--- + +## Clonación y Ejecución Local 💻 + +Clona el repositorio y ejecuta Bridge localmente: + +```sh +git clone https://github.com/Dev2Forge/bridge.git +cd bridge +python -m venv .venv +.venv\Scripts\activate # En Windows +# source .venv/bin/activate # En Linux/MacOS +pip install -r requirements.txt +python -m src.bridge +``` + +--- + +## Uso Básico 🚀 + +1. Ejecute la aplicación desde la terminal o entorno gráfico. +2. Seleccione el archivo a convertir. +3. Revise y edite el resultado si es necesario. +4. Guarde el archivo en formato Markdown. + +--- + +## Formatos Soportados 📂 + +Bridge admite la conversión de los siguientes formatos de archivo: + +- PDF (`.pdf`) +- Word (`.docx`) +- PowerPoint (`.pptx`) +- Excel (`.xlsx`, `.xls`, `.csv`) +- Mensajes Outlook (`.msg`) +- Texto (`.txt`, `.text`) +- Markdown (`.md`, `.markdown`) +- JSON (`.json`, `.jsonl`) +- XML (`.xml`) +- RSS/Atom (`.rss`, `.atom`) +- HTML/MHTML (`.html`, `.htm`, `.mhtml`) +- ePub (`.epub`) +- Archivos comprimidos (`.zip`) +- Jupyter Notebooks (`.ipynb`) +- Otros formatos compatibles con Markitdown + +--- + +## Limitaciones ⚠️ + +Bridge no es un IDE, editor de texto, editor de Markdown ni visor de documentos. Su propósito es servir como puente entre el usuario y la conversión a Markdown, ofreciendo una edición ligera y sin funcionalidades de edición avanzada. + +--- + +## Releases 🏷️ + +Consulta las versiones publicadas y notas de lanzamiento en la sección [Releases](https://github.com/Dev2Forge/bridge/releases) del repositorio. + +--- + +## Dependencias y licencias 📚 + +Este proyecto utiliza librerías de terceros, cada una con su propia licencia. Consulte la carpeta [third-party](../third-party/) para más información. + +--- + +## Contribuir 🤝 + +Las contribuciones son bienvenidas. Por favor, abra un issue o pull request siguiendo las buenas prácticas de la comunidad open source. + +--- + +## Licencia 📄 + +Distribuido bajo la [Licencia MIT](./LICENSE). + +©2025 Dev2Forge \ No newline at end of file