{"id":13823592,"url":"https://github.com/viperadnan-git/wallpaper-api","last_synced_at":"2025-07-08T18:30:37.436Z","repository":{"id":54599346,"uuid":"447249280","full_name":"viperadnan-git/wallpaper-api","owner":"viperadnan-git","description":"An api which can use different sites to scrape images and serve them through API","archived":true,"fork":false,"pushed_at":"2022-01-12T15:05:42.000Z","size":107,"stargazers_count":33,"open_issues_count":0,"forks_count":11,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-20T01:33:12.663Z","etag":null,"topics":["deta","fastapi","heroku","wallpaper","wallpaper-api","wallpaper-changer"],"latest_commit_sha":null,"homepage":"https://wlpr-api.herokuapp.com/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/viperadnan-git.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-01-12T14:28:25.000Z","updated_at":"2024-10-20T11:52:27.000Z","dependencies_parsed_at":"2022-08-13T21:00:15.895Z","dependency_job_id":null,"html_url":"https://github.com/viperadnan-git/wallpaper-api","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/viperadnan-git/wallpaper-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viperadnan-git%2Fwallpaper-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viperadnan-git%2Fwallpaper-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viperadnan-git%2Fwallpaper-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viperadnan-git%2Fwallpaper-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/viperadnan-git","download_url":"https://codeload.github.com/viperadnan-git/wallpaper-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viperadnan-git%2Fwallpaper-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264323846,"owners_count":23590751,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deta","fastapi","heroku","wallpaper","wallpaper-api","wallpaper-changer"],"created_at":"2024-08-04T09:00:37.667Z","updated_at":"2025-07-08T18:30:37.125Z","avatar_url":"https://github.com/viperadnan-git.png","language":"HTML","readme":"\u003cdiv align=\"center\"\u003e\n\u003ch1\u003eWallpapers API\u003c/h1\u003e\n\n\u003cimg height=\"20px\" src=\"https://forthebadge.com/images/badges/works-on-my-machine.svg\"\u003e\n\u003cimg height=\"20px\" src=\"https://img.shields.io/badge/version-0.1.0-F05032?style=for-the-badge\u0026logo=git\"\u003e\n\nAn api which can use different sites to scrape images and serve them through API\n\n**This API can be used for setting daily wallpapers on a mobile device by combining it with an app such as IFTTT**\n\u003c/div\u003e\n\n## Installation\n\nThis is an ASGI server built using FastAPI. Here are some PaaS which is supported and you can deploy directly by clicking on the link below.\n\n[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?repo=https://github.com/viperadnan-git/wallpaper-api)\n\u003ca href=\"https://go.deta.dev/deploy?repo=https://github.com/viperadnan-git/wallpaper-api\"\u003e\n    \u003cimg height=\"32\" src=\"https://button.deta.dev/1/svg\" alt=\"Deploy\"\u003e\n\u003c/a\u003e\n\nOr you can install it on your private server, the steps are given below.\n\n### Installing Prerequisite\nThis project is written on python. Hence, install python-3.8.6 or later, see [`runtime.txt`](./runtime.txt) for exact version. \n\nOn Ubuntu-18.04 or later\n```sh\napt-get install -y python3 python3-pip\n```\n\n### Installing Python Packages\nInstall the required packages using pip\n```sh\npip install -r requirements.txt\n```\n\n### Configuration\n\n**Wallpaper website**\n\nBy default, it's scrapes wallpapers from \u003chttps://wallpapercave.com\u003e. You can configure your desired wallpapers site's url and scraping regex in [`config.json`](./config.json)\n\n**Collections**\n\nThis app uses collections name from [`collections.txt`](collections.txt) to fetch wallpapers from website and this list can be updated (as new collections arriving daily) by running the collection [`scraper`](scrape_collections.py). It have two modes, add collection from search or automaticaly fetch all collections.\n\n_Note: Random wallpaper feature didn't work if collections file is empty so we added some nice collections already. You can remove file and add your own desired collections_\n```sh\npython3 scrape_collections.py\n```\nThis will fetch and update the collection file automatically.\n\n### Start Server\nStart the ASGI server using **uvicorn**\n```sh\nuvicorn main:app\n```\n\nIf using a VPS then set the host and port accordingly\n```sh\nuvicorn main:app --host 0.0.0.0 --port 80\n```\n\n[`Procfile`](./Procfile) already exists if you want to deploy it on railway or heroku etc.\n\n## Copyright \u0026 License\n\nCopyright (©) 2022 by [Adnan Ahmad](https://github.com/viperadnan-git).\nLicensed under the terms of the [GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007](./LICENSE)","funding_links":[],"categories":["HTML"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fviperadnan-git%2Fwallpaper-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fviperadnan-git%2Fwallpaper-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fviperadnan-git%2Fwallpaper-api/lists"}