https://github.com/jesssullivan/fastphotoapi
An efficient, flexible, flask-based image server using Lanczos resampling
https://github.com/jesssullivan/fastphotoapi
docker flask koyeb lanczos static-api
Last synced: 7 months ago
JSON representation
An efficient, flexible, flask-based image server using Lanczos resampling
- Host: GitHub
- URL: https://github.com/jesssullivan/fastphotoapi
- Owner: Jesssullivan
- License: apache-2.0
- Created: 2023-12-13T16:42:07.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-20T20:45:58.000Z (10 months ago)
- Last Synced: 2025-03-23T21:47:33.531Z (7 months ago)
- Topics: docker, flask, koyeb, lanczos, static-api
- Language: Python
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FastPhotoAPI
An efficient, flexible, flask-based image server that uses lanczos resampling to serve optimized cached photos.
```shell
python3.12 -m venv fast_photo_venv
source fast_photo_venv/bin/activate
pip install -r requirements.txt
```
## Usage:
- Resample & fetch a cached image `/image/`
- Resample and fetch an image with a specific max dimension:
- `/image/?w=69` or
- `/image/` or
- `/image/?w=69&h=42`
- Fetch the original, unmodified image `/full/`
## Structure:
This application adopts the factory pattern; `flask run` instantiates the built-in development server by executing `create_app()` at the root of the `app/` package, while `python application.py` creates a new production application, served by waitress.
```shell
.
├── app
├── __init__.py # create and serve development application
└── main
├── config
│ │ ├── conf.py # Utility configs and methods
│ │ └── config.cfg # set directories, max image dimensions, etc
│ ├── fullsize
│ │ └── routes.py # Blueprint routing for serving verbatim image files
│ ├── __init__.py # `create_app()` entrypoint
│ ├── resampled
│ │ ├── model.py # Image resampling methods
│ │ ├── trashd.py # garbage collector daemon
│ │ └── routes.py # Blueprint routing for `/image/`
│ └── static
│ └── routes.py # Blueprint routing for `/static/`
├── application.py # create and serve production application w/ waitress
├── cache # resampled images are dynamically generated adn stored here
├── Dockerfile # currently deployed at Koyeb
├── pictures # full res pictures go here
├── README.md # you are here
├── static
│ └── style.css # index styling
└── templates
├── index.html
└── upload.html
```
## Build
*Locally:*
```dev server:
flask run # 0.0.0.0:5000
```
```waitress server:
flask run # 0.0.0.0:8000
```
*Production via Docker:*
```shell
## build production docker image:
docker build -t .
## serve production docker image locally:
docker run -d -p 8000:8000 :latest
## stop local image:
# docker ps
# docker stop
## push image to a container registery:
# docker push
```