{"id":21250908,"url":"https://github.com/natlee/eagle-wrapper","last_synced_at":"2025-07-24T05:37:02.137Z","repository":{"id":151333907,"uuid":"624084069","full_name":"NatLee/Eagle-Wrapper","owner":"NatLee","description":"This is a python wrapper for a management software of images named Eagle.","archived":false,"fork":false,"pushed_at":"2023-04-06T04:10:51.000Z","size":1157,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-11T05:14:30.789Z","etag":null,"topics":["eagle","image-management","image-manager","wrapper","wrapper-api"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/EagleWrapper/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NatLee.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-05T17:57:34.000Z","updated_at":"2024-08-02T18:43:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"be2cffae-6c63-4e75-9b12-982ea39ae1af","html_url":"https://github.com/NatLee/Eagle-Wrapper","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/NatLee/Eagle-Wrapper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NatLee%2FEagle-Wrapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NatLee%2FEagle-Wrapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NatLee%2FEagle-Wrapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NatLee%2FEagle-Wrapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NatLee","download_url":"https://codeload.github.com/NatLee/Eagle-Wrapper/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NatLee%2FEagle-Wrapper/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266796910,"owners_count":23985495,"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","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["eagle","image-management","image-manager","wrapper","wrapper-api"],"created_at":"2024-11-21T03:39:33.459Z","updated_at":"2025-07-24T05:37:02.102Z","avatar_url":"https://github.com/NatLee.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cdiv align=\"center\" style=\"text-align: center\"\u003e\n\n\u003cp style=\"text-align: center\"\u003e\n  \u003cimg align=\"center\" src=\"https://raw.githubusercontent.com/NatLee/Eagle-Wrapper/main/doc/repo-logo.png\" alt=\"Eagle Wrapper\"\u003e\n\u003c/p\u003e\n\n**Eagle Wrapper - A wrapper for Eagle API**\n\n[![PyPI pyversions](https://img.shields.io/pypi/pyversions/EagleWrapper.svg)](https://pypi.python.org/pypi/EagleWrapper/) [![PyPI implementation](https://img.shields.io/pypi/implementation/EagleWrapper.svg)](https://pypi.python.org/pypi/EagleWrapper/)\n\n[![Test](https://github.com/NatLee/Eagle-Wrapper/actions/workflows/test.yml/badge.svg)](https://github.com/NatLee/Eagle-Wrappger/actions/workflows/test.yml) [![Release](https://github.com/NatLee/Eagle-Wrapper/actions/workflows/release.yml/badge.svg)](https://github.com/NatLee/Eagle-Wrapper/actions/workflows/release.yml)\n\n[![PyPI status](https://img.shields.io/pypi/status/EagleWrapper.svg)](https://pypi.python.org/pypi/EagleWrapper/) [![PyPI license](https://img.shields.io/pypi/l/EagleWrapper.svg)](https://pypi.python.org/pypi/EagleWrapper/)\n\n[![PyPI version fury.io](https://badge.fury.io/py/eaglewrapper.svg)](https://pypi.python.org/pypi/EagleWrapper/)\n\n[![PyPI download month](https://img.shields.io/pypi/dm/EagleWrapper.svg)](https://pypi.python.org/pypi/EagleWrapper/) [![PyPI download week](https://img.shields.io/pypi/dw/EagleWrapper.svg)](https://pypi.python.org/pypi/EagleWrapper/) [![PyPI download day](https://img.shields.io/pypi/dd/EagleWrapper.svg)](https://pypi.python.org/pypi/EagleWrapper/)\n\n[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)\n\n\u003c/div\u003e\n\n---\n\nThis is a python wrapper for a image and design management software named Eagle.\n\nIts official website is https://eagle.cool/.\n\n\n## API Reference\n\nThis wrapper is reference from [Eagle Official API documentation](https://api.eagle.cool/)\n\nList APIs are available in this wrapper.\n\n### Applications\n\n- [x] /api/application/info -\u003e `get_application_info`\n\n### Folder\n\n- [x] /api/folder/create -\u003e `create_folder`\n- [x] /api/folder/rename -\u003e `rename_folder`\n- [x] /api/folder/update -\u003e `update_folder`\n- [x] /api/folder/list -\u003e `list_folders`\n- [x] /api/folder/listRecent -\u003e `get_recent_folders`\n\n### Item\n\n- [x] /api/item/addFromURL -\u003e `add_from_url`\n- [x] /api/item/addFromURLs -\u003e `add_from_urls`\n- [x] /api/item/addFromPath -\u003e `add_from_path`\n- [x] /api/item/addFromPaths -\u003e `add_from_paths`\n- [x] /api/item/addBookmark -\u003e `add_bookmark`\n- [x] /api/item/info -\u003e `get_item_info`\n- [x] /api/item/thumbnail -\u003e `get_thumbnail_path`\n- [x] /api/item/list -\u003e `list_items`\n- [x] /api/item/moveToTrash -\u003e `move_to_trash`\n- [x] /api/item/refreshPalette -\u003e `refresh_palette`\n- [x] /api/item/refreshThumbnail -\u003e `refresh_thumbnail`\n- [x] /api/item/update -\u003e `update_item`\n\n### Library\n\n- [x] /api/library/info -\u003e `get_library_info`\n- [x] /api/library/history -\u003e `get_library_history`\n- [x] /api/library/switch -\u003e `switch_library`\n\n## Usage\n\n```bash\npip install EagleWrapper\n```\n\n\u003e Notice: You need open Eagle when using this wrapper or it cannot find your host of Eagle.\n\n## Method\n\n- get_img_info_from_lib_path\n\n\u003e This is a method of searching file `metadata.json` of images from directly library folder, so it will fast than using `get_img_list_info`.\n\n```python\nfrom eaglewrapper import Eagle\neagle = Eagle()\nsource_path = '/my/lib/path/example/測試.library' # your library path\nname_start_filters = ['example', 'ぼ'] # your filters with the image name\nimage_info = eagle.get_img_info_from_lib_path(source_path, name_start_filters)\n```\n\n- add_from_url\n\n```python\nfrom eaglewrapper import Eagle\neagle = Eagle()\nurl = 'https://s.yimg.com/ny/api/res/1.2/1ui_Mvv4s2Gtmr4uZdP.mA--/YXBwaWQ9aGlnaGxhbmRlcjt3PTk2MDtoPTY4NDtjZj13ZWJw/https://s.yimg.com/os/creatr-uploaded-images/2022-11/1f7132d0-5e6a-11ed-b7bd-ba3b4a3aed4f'\nname = 'ぼっち・ざ・ろっく！'\ntags = ['ぼっち', 'ろっく']\nwebsite = 'https://tw.news.yahoo.com/bocchi-the-rock-071607480.html'\nannotation = 'This is an example ;)'\neagle.add_from_url(url, name, tags, website, annotation)\n```\n\nThis output will show in Eagle:\n\n![add-from-url](https://raw.githubusercontent.com/NatLee/Eagle-Wrapper/main/doc/add-from-url.png)\n\n- get_img_list_info\n\nList image INFO which name starting with `ぼ` in limit 10.\n\n```python\nfrom eaglewrapper import Eagle\neagle = Eagle()\nmax_image_number = 10 # maximum number of images for searching\nname_start_filter = 'ぼ' # search filters\nimage_list_info = eagle.get_img_list_info(max_image_number, name_start_filter)\n```\n\nThe output is:\n\n```json\n[{\n    \"id\": \"LG3YCGZW5QH1B\",\n    \"name\": \"ぼっち・ざ・ろっく！\",\n    \"size\": 219336,\n    \"btime\": 1680715050765,\n    \"mtime\": 1680715050880,\n    \"ext\": \"jpg\",\n    \"tags\": [\"ぼっち\", \"ろっく\"],\n    \"folders\": [],\n    \"isDeleted\": false,\n    \"url\": \"https://tw.news.yahoo.com/bocchi-the-rock-071607480.html\",\n    \"annotation\": \"This is an example ;)\",\n    \"modificationTime\": 1680715050761,\n    \"height\": 684,\n    \"width\": 960,\n    \"noThumbnail\": true,\n    \"palettes\": [\n        {\n            \"color\": [196, 172, 154],\n            \"ratio\": 33,\n            \"$$hashKey\": \"object:1775\"\n        },\n        {\n            \"color\": [48, 43, 43],\n            \"ratio\": 26,\n            \"$$hashKey\": \"object:1776\"\n        },\n        ...\n        {\n            \"color\": [225, 204, 205],\n            \"ratio\": 2.66,\n            \"$$hashKey\": \"object:1783\"\n        }\n    ]\n}]\n```\n\n## Contributor\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/NatLee\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/10178964?v=3?s=100\" width=\"100px;\" alt=\"Nat Lee\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eNat Lee\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\n## License\n\n[MIT](LICENSE)\n\n\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatlee%2Feagle-wrapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnatlee%2Feagle-wrapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatlee%2Feagle-wrapper/lists"}