Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 2.76 KB

README.md

File metadata and controls

80 lines (53 loc) · 2.76 KB

LinguaDoc 🐍🤖📄

License Python PySide6 Python

LinguaDoc is a Python-based desktop application built using PySide6 and BasicLingua. The application provides translation functionalities and document generation features with a focus on efficient async operations.

Features ⚓

  • GUI: Utilize PySide6 for the graphical user interface.
  • Translation Functionalities: Utilize BasicLingua for language translation.
  • Document Generation: Generate documents efficiently with pydocx.
  • Concurrent execution: Perform tasks asynchronously for better performance with threading.

Table of Contents

How LinguaDoc works

By clicking on the Text Translation, users are taken to a page where they can input the API key required for initializing the BasicLingua library . This key is essential for accessing and utilizing the library's feature of Text Translation. Upon accessing the page, users are prompted to obtain an API key from here for the initialization of the BasicLingua library.

Installation

The application has been bundled into a setup file, allowing you to install and run it locally without needing to have Python installed on your machine. This ensures that our non-coder friends can also use the application with ease.

You can download the setup file from the following link:

Download Setup File

Prerequisites

  • Python 3.11
  • pip (Python package installer)

Steps

  1. Clone the repository:

    git clone https://github.com/yourusername/LinguaDoc.git
    cd LinguaDoc
  2. Create and activate a virtual environment (optional but recommended):

    python -m venv venv
    cd venv\Scripts\activate
  3. Install the required packages:

    pip install -r requirements.txt

Usage

Run the application:

python LinguaDoc.py

Snapshots of the application

Contributions

We are excited to receive contributions! Please refer to our CONTRIBUTIONS.md for comprehensive steps on submitting pull requests to the project.