Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Bridge 🌉🐍
# Bridgex 🌉🐍

[![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/)
[![PyPI version](https://img.shields.io/pypi/v/bridgex-md.svg)](https://pypi.org/project/bridgex-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)
[![Issues](https://img.shields.io/github/issues/Dev2Forge/bridgex)](https://github.com/Dev2Forge/bridgex/issues)

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.
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

- [Bridge 🌉🐍](#bridge-)
- [Bridgex 🌉🐍](#bridgex-)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Screenshots](#screenshots)
Expand Down Expand Up @@ -39,8 +39,8 @@ Bridge is an open‑source graphical interface for converting files to Markdown,

## 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.*
![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>
Expand All @@ -49,10 +49,10 @@ Bridge is an open‑source graphical interface for converting files to Markdown,

| 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) |
| 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>

Expand All @@ -67,7 +67,7 @@ Requirements:
Install via pip:

```sh
pip install bridge
pip install bridgex
```

It is recommended to use a virtual environment. To customise supported formats, edit the [`requirements.txt`](./requirements.txt) file as needed.
Expand All @@ -76,16 +76,16 @@ It is recommended to use a virtual environment. To customise supported formats,

## Local Cloning and Execution 💻

Clone the repository and run Bridge locally:
Clone the repository and run Bridgex locally:

```sh
git clone https://github.com/Dev2Forge/bridge.git
cd bridge
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.bridge
python -m src.bridgex
```

---
Expand All @@ -101,7 +101,7 @@ python -m src.bridge

## Supported Formats

Bridge supports conversion of the following file formats:
Bridgex supports conversion of the following file formats:

* PDF (`.pdf`)
* Word (`.docx`)
Expand All @@ -123,13 +123,13 @@ Bridge supports conversion of the following file formats:

## Limitations

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.
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/bridge/releases) section of the repository.
Check the published versions and release notes in the [Releases](https://github.com/Dev2Forge/bridgex/releases) section of the repository.

---

Expand Down
83 changes: 83 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
[build-system]
requires = ["setuptools>=67.0.0", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "bridgex"
version = "0.0.1-dev"
description = "graphical interface for converting files to Markdown, built in Python and based on PySide6 and Markitdown"
readme = { file = "README.md", content-type = "text/markdown", charset = "utf-8" }
license = "MIT"
authors = [{ name = "dev2forge", email = "bridgex@dev2forge.software" }]
maintainers = [{ name = "tutosrive", email = "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"
]

dependencies = [
"markitdown[pdf,docx,pptx,xls,xlsx,outlook]==0.1.1",
"chromologger==0.1.8",
"PySide6-Essentials==6.9.0",
"sqlazo==0.1.5",
"chromolog==0.2.4"
]
requires-python = ">=3.9,<=3.13"

classifiers = [
"Development Status :: 3 - Alpha",
"Intended Audience :: End Users/Desktop",
"Intended Audience :: Developers",
"Topic :: Utilities",
"Topic :: Text Processing :: Markup",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Environment :: X11 Applications :: Qt",
"Environment :: Win32 (MS Windows)",
"Environment :: MacOS X"
]

[project.scripts]
bridgex = "bridgex.__main__:main"

[project.urls]
Homepage = "https://github.com/Dev2Forge/bridgex"
Repository = "https://github.com/Dev2Forge/bridgex"
Issues = "https://github.com/Dev2Forge/bridgex/issues"

[tool.setuptools]
package-dir = {"" = "src"}
packages = { find = { where = ["src"] } }

[tool.setuptools.package-data]
bridgex = [
"NOTICE",
"OSL/*",
"interface/assets/*",
"logs/*",
"interface/translations/*"
]
6 changes: 0 additions & 6 deletions src/bridge/__init__.py

This file was deleted.

7 changes: 0 additions & 7 deletions src/bridge/__main__.py

This file was deleted.

Binary file not shown.
Loading