https://github.com/woctezuma/heroku-flask-api

Deploy an API built with Flask on Heroku, in order to match game banners.
https://github.com/woctezuma/heroku-flask-api

api clip flask heroku openai

Last synced: about 1 month ago
JSON representation

Deploy an API built with Flask on Heroku, in order to match game banners.

• Host: GitHub
• URL: https://github.com/woctezuma/heroku-flask-api
• Owner: woctezuma
• License: mit
• Created: 2021-01-18T10:06:05.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-11-20T07:59:51.000Z (about 2 years ago)
• Last Synced: 2023-03-11T16:58:04.821Z (almost 2 years ago)
• Topics: api, clip, flask, heroku, openai
• Language: Python
• Homepage: https://damp-brushlands-51855.herokuapp.com/render/1091500/
• Size: 22.7 MB
• Stars: 1
• Watchers: 2
• Forks: 3
• Open Issues: 51
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Heroku Flask API

Deploy an API built with Flask on Heroku.

## Data

Data consists of images from the Steam store (~30k games) downloaded [on January 9, 2021][data-snapshot].

## Usage

To run locally:

```bash

python run.py

```

To deploy:

```bash

heroku login

heroku create

git push heroku main

```

## Web App

The web app can be accessed at this URL:

> https://damp-brushlands-51855.herokuapp.com/

To ask for results about Cyberpunk 2077, you have to append the appID (`1091500`) to the `/render/` endpoint:

> https://damp-brushlands-51855.herokuapp.com/render/1091500/

Or you can try your luck with a random game. **Caveat: some Steam games can be offensive!**

> https://damp-brushlands-51855.herokuapp.com/render/

### Number of matches

To tweak the number of matches, for instance to 5 instead of the default (11):

`render/1091500/5`

### Direct links to the Steam store

To have direct links to the Steam store:

`store/1091500/`

### Mirror and flip

CLIP seems be attentive to texts present on images.

To try to mitigate this effect, the query image can be:

-   mirrored (i.e. horizontally),

-   flipped (i.e. vertically).

To mirror the query image:

`render_x/` or `render/?mirror=1`

To flip the query image:

`render_y/` or `render/?flip=1`

To mirror and flip the query image:

`render_xy/` or `render/?mirror=1&flip=1`

## References

- [`steam-CLIP`][banner-repository-CLIP]: retrieve games with similar banners, using OpenAI's CLIP (resolution 224),

- [`heroku-flask-api`][my-flask-API]: serve the matching results through an API built with Flask on Heroku,

- [`heroku-clip`][heroku-app-CLIP]: deploy an app built with Streamlit on Heroku.

[data-snapshot]: 

[banner-repository-CLIP]: 

[my-flask-API]: 

[heroku-app-CLIP]: