{"id":17176105,"url":"https://github.com/xdynix/pixivpixie","last_synced_at":"2025-02-23T18:34:50.928Z","repository":{"id":57453183,"uuid":"119180595","full_name":"Xdynix/PixivPixie","owner":"Xdynix","description":"User-friendly Pixiv API based on PixivPy","archived":false,"fork":false,"pushed_at":"2021-05-28T22:35:02.000Z","size":1904,"stargazers_count":23,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"remake-2","last_synced_at":"2024-04-06T09:21:46.542Z","etag":null,"topics":["pixiv","pixiv-api","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Xdynix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-27T16:22:54.000Z","updated_at":"2022-10-05T01:17:48.000Z","dependencies_parsed_at":"2022-08-29T06:51:14.592Z","dependency_job_id":null,"html_url":"https://github.com/Xdynix/PixivPixie","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xdynix%2FPixivPixie","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xdynix%2FPixivPixie/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xdynix%2FPixivPixie/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xdynix%2FPixivPixie/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Xdynix","download_url":"https://codeload.github.com/Xdynix/PixivPixie/tar.gz/refs/heads/remake-2","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219846069,"owners_count":16556436,"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":["pixiv","pixiv-api","python"],"created_at":"2024-10-14T23:59:04.306Z","updated_at":"2024-10-14T23:59:05.003Z","avatar_url":"https://github.com/Xdynix.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PixivPixie\n\n**This project is under remaking. If you want to browse the old version, please switch to the `master` branch.**\n\nUser-friendly Pixiv API based on [PixivPy](https://github.com/upbit/pixivpy)\n\n## Installation\n\n```shell script\npip install --upgrade PixivPixie\n```\n\n## Disclaimer\n\nThis project is for learning and communication only. It is **NOT** recommended to use it in large-scale. High-frequency queries\n will add pressure to the server. Please support [Pixiv Premium](https://www.pixiv.net/premium.php) if you can.\n\n免责声明：本项目仅用于学习与交流。作者**不鼓励**大规模使用。频繁访问会对服务器带来压力。 请尽量支持\n[Pixiv高级会员](https://www.pixiv.net/premium.php)。\n\n## About\n\n`PixivPy` is rather a powerful Pixiv API. But its responses are raw json and need further processing before being used. And\nboth `PublicAPI` and `AppAPI` has its pros and cons.\n\nThis package is designed to serve as a proxy API for `PixivPy`. User can just fetch illustrations they want and doesn't need to\nthink about trifles like paging parameters or response's json structure.\n\nMy main motivation is to write a pixiv crawler to download images. So unrelated APIs are not implemented. It's welcome to help\nme implement those APIs.\n\nP.S. English and Chinese discussion is OK. Please forgive me for the poor English. Fixing typo is also welcome.\n\n## Development\n\n```shell script\ngit clone https://github.com/Xdynix/PixivPixie.git\ncd PixivPixie\n\n# Setup and activate virtualenv.\nvirtualenv venv  # Please use the name `venv`, otherwise the configuration file may not work properly.\n.\\venv\\Scripts\\activate  # On Windows environment.\nsource venv/bin/activate  # On POSIX (Linux/MacOS/Other) environment.\n\npip install -r requirements.txt\npip install -r requirements-dev.txt\npip install -e .\npre-commit install\n```\n\nTo run tests, simply use command `pytest`.\n\n---\n\nTo run web tests, which will check the availability of Pixiv's API and the schema of the response data, you need to first\ncreate the file `secret.json` in the root directory of the project, and fill in the account information you will use for\ntesting in the following format:\n\n```json\n{\n  \"password\": \"pa33w0rd\",\n  \"refresh_token\": \"123456789_abcdefghijk\",\n  \"requests_kwargs\": {},\n  \"username\": \"foobar@example.com\"\n}\n```\n\nThen use command `pytest webtests --no-cov` to run web tests.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxdynix%2Fpixivpixie","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxdynix%2Fpixivpixie","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxdynix%2Fpixivpixie/lists"}