bridgex


Namebridgex JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryGraphical interface for converting files to Markdown, built in Python and based on PySide6 and Markitdown.
upload_time2025-07-10 01:55:19
maintainerNone
docs_urlNone
authorNone
requires_python<=3.13,>=3.9
licenseNone
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
VCS
bugtrack_url
requirements markitdown chromologger PySide6-Essentials sqlazo chromolog
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Bridgex 🌉🐍

[![Read in Spanish](https://img.shields.io/badge/read%20in-ES-red?logo=github)](https://github.com/Dev2Forge/bridgex/blob/main/translations/README_ES.md)
[![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.

---

## 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`](https://github.com/Dev2Forge/bridgex/blob/main/requirements.txt) file as needed.

---

## Local Cloning and Execution 💻

Clone the repository and run Bridgex locally:

1. Clone the repository.

```sh
git clone https://github.com/Dev2Forge/bridgex.git
```

2. Navigate to the project directory and set up a virtual environment.
```sh
cd bridgex
```
3. Create a virtual environment.

```sh
python -m venv .venv
```

4. Activate the virtual environment.

```sh
# On Windows
.venv\Scripts\activate
# source .venv/bin/activate  # On Linux/MacOS
```

5. Install the required dependencies.

```sh
pip install -r requirements.txt
```

6. Run the application.

```sh
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](https://github.com/Dev2Forge/bridgex/tree/main/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](https://github.com/Dev2Forge/bridgex/blob/main/LICENSE).

©2025 Dev2Forge

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "bridgex",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<=3.13,>=3.9",
    "maintainer_email": "tutosrive <tutosrive@dev2forge.software>",
    "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",
    "author": null,
    "author_email": "dev2forge <bridgex@dev2forge.software>",
    "download_url": "https://files.pythonhosted.org/packages/9e/96/4b9267d997c49bb42916e5f3da360508b8559401a3102015c93115937124/bridgex-0.1.0.tar.gz",
    "platform": null,
    "description": "# Bridgex \ud83c\udf09\ud83d\udc0d\r\n\r\n[![Read in Spanish](https://img.shields.io/badge/read%20in-ES-red?logo=github)](https://github.com/Dev2Forge/bridgex/blob/main/translations/README_ES.md)\r\n[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)\r\n![Pepy Total Downloads](https://img.shields.io/pepy/dt/bridgex)\r\n[![PyPI version](https://img.shields.io/pypi/v/bridgex?label=bridgex)](https://pypi.org/project/bridgex/)\r\n[![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/)\r\n[![Issues](https://img.shields.io/github/issues/Dev2Forge/bridgex)](https://github.com/Dev2Forge/bridgex/issues)\r\n\r\nBridgex is an open\u2011source 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.\r\n\r\n---\r\n\r\n## Features \u2728\r\n\r\n* Cross\u2011platform graphical interface.\r\n* Efficient file\u2011to\u2011Markdown conversion.\r\n* Modularity: easy to adapt and extend.\r\n* Support for multiple input formats.\r\n* Lightweight editing prior to saving.\r\n\r\n---\r\n\r\n## Screenshots \ud83d\uddbc\ufe0f\r\n\r\n![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridgex/preview-1-main.png)\r\n*Example of Bridgex\u2019s main window.*\r\n\r\n<details>\r\n<summary><strong>View interface previews</strong></summary>\r\n\r\n<br>\r\n\r\n|     Name     | Preview |\r\n|:----------------:|:---------------------:|\r\n| Open File | ![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridgex/preview-2-openfile.png) |\r\n| Mini Editor | ![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridgex/preview-3-minieditor.png) |\r\n| Convert | ![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridgex/preview-4-convert.png) |\r\n| Change Language | ![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridgex/preview-5-languagechange.png) |\r\n\r\n</details>\r\n\r\n---\r\n\r\n## Installation \ud83d\udce6\r\n\r\nRequirements:\r\n\r\n* Python \u2265 **3.9** and \u2264 **3.13**\r\n\r\nInstall via pip:\r\n\r\n```sh\r\npip install bridgex\r\n```\r\n\r\nStart Bridgex from the terminal:\r\n\r\n```sh\r\nbridgex\r\n```\r\n\r\nIt is recommended to use a virtual environment. To customise supported formats, edit the [`requirements.txt`](https://github.com/Dev2Forge/bridgex/blob/main/requirements.txt) file as needed.\r\n\r\n---\r\n\r\n## Local Cloning and Execution \ud83d\udcbb\r\n\r\nClone the repository and run Bridgex locally:\r\n\r\n1. Clone the repository.\r\n\r\n```sh\r\ngit clone https://github.com/Dev2Forge/bridgex.git\r\n```\r\n\r\n2. Navigate to the project directory and set up a virtual environment.\r\n```sh\r\ncd bridgex\r\n```\r\n3. Create a virtual environment.\r\n\r\n```sh\r\npython -m venv .venv\r\n```\r\n\r\n4. Activate the virtual environment.\r\n\r\n```sh\r\n# On Windows\r\n.venv\\Scripts\\activate\r\n# source .venv/bin/activate  # On Linux/MacOS\r\n```\r\n\r\n5. Install the required dependencies.\r\n\r\n```sh\r\npip install -r requirements.txt\r\n```\r\n\r\n6. Run the application.\r\n\r\n```sh\r\npython -m src.bridgex\r\n```\r\n\r\n---\r\n\r\n## Basic Usage \ud83d\ude80\r\n\r\n1. Run the application from the terminal or GUI.\r\n2. Select the file to convert.\r\n3. Review and edit the result if necessary.\r\n4. Save the file in Markdown format.\r\n\r\n---\r\n\r\n## Supported Formats \ud83d\udcc2\r\n\r\nBridgex supports conversion of the following file formats:\r\n\r\n* PDF (`.pdf`)\r\n* Word (`.docx`)\r\n* PowerPoint (`.pptx`)\r\n* Excel (`.xlsx`, `.xls`, `.csv`)\r\n* Outlook Messages (`.msg`)\r\n* Text (`.txt`, `.text`)\r\n* Markdown (`.md`, `.markdown`)\r\n* JSON (`.json`, `.jsonl`)\r\n* XML (`.xml`)\r\n* RSS/Atom (`.rss`, `.atom`)\r\n* HTML/MHTML (`.html`, `.htm`, `.mhtml`)\r\n* ePub (`.epub`)\r\n* Compressed files (`.zip`)\r\n* Jupyter Notebooks (`.ipynb`)\r\n* Other formats supported by Markitdown\r\n\r\n---\r\n\r\n## Limitations \u26a0\ufe0f\r\n\r\nBridgex 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.\r\n\r\n---\r\n\r\n## Releases \ud83c\udff7\ufe0f\r\n\r\nCheck the published versions and release notes in the [Releases](https://github.com/Dev2Forge/bridgex/releases) section of the repository.\r\n\r\n---\r\n\r\n## Dependencies and Licences \ud83d\udcda\r\n\r\nThis project uses third\u2011party libraries, each with its own licence. See the [third\u2011party](https://github.com/Dev2Forge/bridgex/tree/main/third-party/) folder for more information.\r\n\r\n---\r\n\r\n## Contribute \ud83e\udd1d\r\n\r\nContributions are welcome. Please open an issue or pull request following the community\u2019s best practices.\r\n\r\n---\r\n\r\n## Licence \ud83d\udcc4\r\n\r\nDistributed under the [MIT Licence](https://github.com/Dev2Forge/bridgex/blob/main/LICENSE).\r\n\r\n\u00a92025 Dev2Forge\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Graphical interface for converting files to Markdown, built in Python and based on PySide6 and Markitdown.",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/Dev2Forge/bridgex",
        "Issues": "https://github.com/Dev2Forge/bridgex/issues",
        "Repository": "https://github.com/Dev2Forge/bridgex"
    },
    "split_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"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "eb589e0fd6a17377154763e67be6d4f52b51ef07c97f95fe63689a8f7d334a4a",
                "md5": "536620bc67f2d3cd022fdc4047ef9b85",
                "sha256": "93d7feae30fe9aa1394c0dc09a70bb50bc5dcab76b88f4715767ae6f7f0db72c"
            },
            "downloads": -1,
            "filename": "bridgex-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "536620bc67f2d3cd022fdc4047ef9b85",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<=3.13,>=3.9",
            "size": 1380991,
            "upload_time": "2025-07-10T01:55:17",
            "upload_time_iso_8601": "2025-07-10T01:55:17.578301Z",
            "url": "https://files.pythonhosted.org/packages/eb/58/9e0fd6a17377154763e67be6d4f52b51ef07c97f95fe63689a8f7d334a4a/bridgex-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9e964b9267d997c49bb42916e5f3da360508b8559401a3102015c93115937124",
                "md5": "828b02676e5545d259c42dd0ee8276e0",
                "sha256": "a7648fac04653943457d2460e5231425a01912407e38b7edb8e52f31c9a0917b"
            },
            "downloads": -1,
            "filename": "bridgex-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "828b02676e5545d259c42dd0ee8276e0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<=3.13,>=3.9",
            "size": 1342441,
            "upload_time": "2025-07-10T01:55:19",
            "upload_time_iso_8601": "2025-07-10T01:55:19.784766Z",
            "url": "https://files.pythonhosted.org/packages/9e/96/4b9267d997c49bb42916e5f3da360508b8559401a3102015c93115937124/bridgex-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-10 01:55:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Dev2Forge",
    "github_project": "bridgex",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "markitdown",
            "specs": [
                [
                    "==",
                    "0.1.1"
                ]
            ]
        },
        {
            "name": "chromologger",
            "specs": [
                [
                    "==",
                    "0.1.8"
                ]
            ]
        },
        {
            "name": "PySide6-Essentials",
            "specs": [
                [
                    "==",
                    "6.9.0"
                ]
            ]
        },
        {
            "name": "sqlazo",
            "specs": [
                [
                    "==",
                    "0.1.5"
                ]
            ]
        },
        {
            "name": "chromolog",
            "specs": [
                [
                    "==",
                    "0.2.4"
                ]
            ]
        }
    ],
    "lcname": "bridgex"
}
        
Elapsed time: 0.41023s