memes-api icon indicating copy to clipboard operation
memes-api copied to clipboard

API for scrapping common 🇵🇱 meme sites

Memes API Build Status codecov

API for scrapping common meme sites. Written in Python using parsel and Flask. Currently supports:

No sites to be supported, suggest one?

API

/

Response: available sites

[
  "/kwejk",
  "/jbzd",
  "/9gag",
  "/9gagnsfw",
  "/demotywatory",
  "/mistrzowie",
  "/anonimowe",
  "/ifunnyco"
]

Then you can access them by accessing fe. /kwejk

//shortened response
{
  "memes": [
    {
      "title": "Czasy się zmieniają",
      "url": "https://kwejk.pl/obrazek/3387625/czasy-sie-zmieniaja.html",
      "view_url": "/kwejk/3387625",
      "author": {
        "name": "Torendil",
        "url": "https://kwejk.pl/uzytkownik/torendil"
      },
      "comment_count": 18,
      "content": {
        "contentType": "IMAGE",
        "url": "https://i1.kwejk.pl/k/obrazki/2019/05/lJUqdnyKqJf1Katl.jpg"
      },
      "points": 205,
      "tags": [
        {
          "name": "#obrazek",
          "url": "https://kwejk.pl/tag/obrazek"
        },
        {
          "name": "#humor",
          "url": "https://kwejk.pl/tag/humor"
        },
        {
          "name": "#mem",
          "url": "https://kwejk.pl/tag/mem"
        },
        {
          "name": "#true",
          "url": "https://kwejk.pl/tag/true"
        }
      ]
    }
  ],
  "next_page_url": "/kwejk/page/40878",
  "title": "Ministerstwo memów, zdjęć i innych śmiesznych obrazków - KWEJK.pl"
}

Development

  1. Install dependencies with pipenv
  2. Run development server with python main.py
  3. Make your changes
  4. Write and run tests with pytest in project directory
  5. Format your code using black
  6. If you added new packages run pipenv run pipenv_to_requirements -f
  7. Make a pull request and be happy :)

Deploying Memes API

There are couple ways to deploy Memes API. For now supported options are:

  • Docker image (Dockerfile)
  • ZEIT Now (now.json)
  • Google App Engine (app.yaml)