Giter Club home page Giter Club logo

flask_libreoffice_api's Introduction

LibreOffice REST API

This project is a Stateless REST API that exposes an endpoint for document conversion using the LibreOffice CLI.

Motivation

The motivation for this project was from the issues experienced from another service I was using at work for the same purpose, it had a large memory footprint on our clusters as a result of some zombie processes thereby leading to memory leakages.

Before Implementation image

After Implementation Screen Shot 2022-01-15 at 9 47 37 AM

๐Ÿ˜‡

Getting Started

  1. Ensure you have docker running and enough resources(atleast 2GB RAM) allocated to it.
  2. Build image with docker build -t libreoffice_rest .
  3. Start container with docker run --name libreoffice_rest --rm -p 3000:3000 libreoffice_rest

Accessing Endpoints

There are three endpoint exposed on the project and they are as follows

  • GET /health - Returns a message on how so uppp we are..lol

  • GET / - Returns a greeting message..hehe

  • POST /forms/libreoffice/convert - Takes a multipart form request and returns the converted file.

    Example Request

    curl --location --request POST 'http://0.0.0.0:3000/forms/libreoffice/convert' --form 'files=@"/Users/jesseinit/Downloads/DesignProcessWorkshopbySlidesgo.pptx"'
    

Todo

Feel free to open an issue or a PR for any of the todos below or other improvements.

  • Implement non-root user in the docker image
  • Support other document type conversion
  • Reduce docker image size
  • Optimise how the subprocess is called
  • Add logging and increased granularity
  • Miscellaneous Gunicorn configuration fine-tunning

flask_libreoffice_api's People

Contributors

jesseinit avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.