ImageCrop API

A simple Microservice API that can crop, resize, and convert images.

Usage

All of the endpoints can be accessed without an API key and can be used with either a GET or a POST request. If a GET request is used, then parameters must be added a a query string. If a POST request is used, then the parameters must be in the body of the request. All endpoints are accessed at https://image-crop-api.fly.dev/ .

The documentation can be accessed by going to this docs page. Each function and variable is pretty self explanatory. There is also a a "Try it out" feature available on the documentation in the top right of the endpoint dropdown.

Hosting Yourself

The application can be hosted one of two ways, either by running inside a virtual environment, or via Docker. Currently the only way to host on a non-Linux Operating System is via Docker, as a few of the dependencies don't support anything but Linux.

Host via Docker.

Pre Built Images

docker run ghcr.io/chand1012/image-crop-api:master -p 5000:5000

Building the Docker Image.

If you are trying to run the application on a platform other than a 64-bit x86 Linux system, such as for a Raspberry Pi or M1 Mac, you can build the Docker Image with the following:

# This is assuming you have Docker installed.
git clone https://github.com/chand1012/ImageCropAPI.git
cd ImageCropAPI
docker build . -t image-crop-api:master # This will take about 20 minutes
docker run image-crop-api:master 5000:5000

Docker installation instructions found here.

Running from Source.

This has been tested on Ubuntu 18.04LTS only. Should work the same on Ubuntu 20.04LTS as well.

# this is for Ubuntu Linux. 
# Install equivalent packages for your preferred distribution.
sudo apt update
sudo apt install python3-pip python3-dev build-essential 
git clone https://github.com/chand1012/ImageCropAPI.git
cd ImageCropAPI
sudo pip3 install virtualenv 
python3 -m venv env
source env/bin/activate
pip3 install -r requirements.txt
deactivate

To run the application, you must use the virtual environment installed to the application. If you would rather run with the system Python installation, just skip the virtualenv steps and install the modules with pip3 install -r requirements.txt . This will work on Python >= 3.6.

To run the application:

# assuming you are in the same directory as the application
source env/bin/activate
uvicorn main:app --reload