Skip to content

Latest commit

 

History

History
94 lines (73 loc) · 2.64 KB

README.md

File metadata and controls

94 lines (73 loc) · 2.64 KB

LaTeX Logo LaTeX File Management System

Overview

This repository is a LaTeX file management system with the following key functionalities:

  1. Convert text files to LaTeX format and vice versa.
  2. Convert PDF files to LaTeX format.
  3. Check spelling errors in LaTeX files.

The project is organized into three main folders:

  • download/: Stores output files generated by the system.
  • upload/: Contains input files uploaded for processing.
  • server/: Houses Python code files implementing the core functionalities.

Folder Structure

1. download/

  • This folder contains the output files generated after processing the input files.
  • Types of files: .tex, .pdf, .txt, etc.

2. upload/

  • This folder is used to upload input files for processing.
  • Accepted formats: .tex, .txt, .pdf.

3. server/

  • This folder contains Python scripts to handle various operations:
    • text_to_latex.py: Converts plain text files into LaTeX documents.
    • latex_to_text.py: Converts LaTeX documents back into plain text.
    • pdf_to_latex.py: Extracts LaTeX content from PDF files.
    • spell_checker.py: Checks and highlights spelling errors in LaTeX files.

How to Use

  1. Setup:

    • Clone the repository: 
      git clone <repository_url>
cd <repository_name>
    • Install dependencies (if any): 
      pip install -r requirements.txt

  2. Upload Files:

    • Place the input files in the upload/ folder.

  3. Run Scripts:

    • To convert text to LaTeX: 
      python server/text_to_latex.py
    • To convert LaTeX to text: 
      python server/latex_to_text.py
    • To convert PDF to LaTeX: 
      python server/pdf_to_latex.py
    • To check spelling in a LaTeX file: 
      python server/spell_checker.py

  4. Retrieve Outputs:

    • Processed files will be saved in the download/ folder.

Features

  • Text-Latex Conversion: Create LaTeX documents from plain text effortlessly.
  • Latex-Text Conversion: Extract text content from LaTeX files.
  • PDF-Latex Conversion: Transform PDF content into LaTeX format.
  • Spell Checking: Ensure your LaTeX documents are free from spelling errors.

Requirements

  • Python 3.8 or later
  • Dependencies : blob >>> pip install blob

Contributing

Contributions are welcome! Please fork the repository, make your changes, and submit a pull request.

License

This project is licensed under the MIT License.