https://github.com/natlee/eagle-wrapper
This is a python wrapper for a management software of images named Eagle.
https://github.com/natlee/eagle-wrapper
eagle image-management image-manager wrapper wrapper-api
Last synced: 5 months ago
JSON representation
This is a python wrapper for a management software of images named Eagle.
- Host: GitHub
- URL: https://github.com/natlee/eagle-wrapper
- Owner: NatLee
- License: mit
- Created: 2023-04-05T17:57:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-06T04:10:51.000Z (over 2 years ago)
- Last Synced: 2025-07-11T05:14:30.789Z (6 months ago)
- Topics: eagle, image-management, image-manager, wrapper, wrapper-api
- Language: Python
- Homepage: https://pypi.org/project/EagleWrapper/
- Size: 1.1 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**Eagle Wrapper - A wrapper for Eagle API**
[](https://pypi.python.org/pypi/EagleWrapper/) [](https://pypi.python.org/pypi/EagleWrapper/)
[](https://github.com/NatLee/Eagle-Wrappger/actions/workflows/test.yml) [](https://github.com/NatLee/Eagle-Wrapper/actions/workflows/release.yml)
[](https://pypi.python.org/pypi/EagleWrapper/) [](https://pypi.python.org/pypi/EagleWrapper/)
[](https://pypi.python.org/pypi/EagleWrapper/)
[](https://pypi.python.org/pypi/EagleWrapper/) [](https://pypi.python.org/pypi/EagleWrapper/) [](https://pypi.python.org/pypi/EagleWrapper/)
[](https://www.python.org/)
---
This is a python wrapper for a image and design management software named Eagle.
Its official website is https://eagle.cool/.
## API Reference
This wrapper is reference from [Eagle Official API documentation](https://api.eagle.cool/)
List APIs are available in this wrapper.
### Applications
- [x] /api/application/info -> `get_application_info`
### Folder
- [x] /api/folder/create -> `create_folder`
- [x] /api/folder/rename -> `rename_folder`
- [x] /api/folder/update -> `update_folder`
- [x] /api/folder/list -> `list_folders`
- [x] /api/folder/listRecent -> `get_recent_folders`
### Item
- [x] /api/item/addFromURL -> `add_from_url`
- [x] /api/item/addFromURLs -> `add_from_urls`
- [x] /api/item/addFromPath -> `add_from_path`
- [x] /api/item/addFromPaths -> `add_from_paths`
- [x] /api/item/addBookmark -> `add_bookmark`
- [x] /api/item/info -> `get_item_info`
- [x] /api/item/thumbnail -> `get_thumbnail_path`
- [x] /api/item/list -> `list_items`
- [x] /api/item/moveToTrash -> `move_to_trash`
- [x] /api/item/refreshPalette -> `refresh_palette`
- [x] /api/item/refreshThumbnail -> `refresh_thumbnail`
- [x] /api/item/update -> `update_item`
### Library
- [x] /api/library/info -> `get_library_info`
- [x] /api/library/history -> `get_library_history`
- [x] /api/library/switch -> `switch_library`
## Usage
```bash
pip install EagleWrapper
```
> Notice: You need open Eagle when using this wrapper or it cannot find your host of Eagle.
## Method
- get_img_info_from_lib_path
> 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`.
```python
from eaglewrapper import Eagle
eagle = Eagle()
source_path = '/my/lib/path/example/測試.library' # your library path
name_start_filters = ['example', 'ぼ'] # your filters with the image name
image_info = eagle.get_img_info_from_lib_path(source_path, name_start_filters)
```
- add_from_url
```python
from eaglewrapper import Eagle
eagle = Eagle()
url = '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'
name = 'ぼっち・ざ・ろっく！'
tags = ['ぼっち', 'ろっく']
website = 'https://tw.news.yahoo.com/bocchi-the-rock-071607480.html'
annotation = 'This is an example ;)'
eagle.add_from_url(url, name, tags, website, annotation)
```
This output will show in Eagle:
- get_img_list_info
List image INFO which name starting with `ぼ` in limit 10.
```python
from eaglewrapper import Eagle
eagle = Eagle()
max_image_number = 10 # maximum number of images for searching
name_start_filter = 'ぼ' # search filters
image_list_info = eagle.get_img_list_info(max_image_number, name_start_filter)
```
The output is:
```json
[{
"id": "LG3YCGZW5QH1B",
"name": "ぼっち・ざ・ろっく！",
"size": 219336,
"btime": 1680715050765,
"mtime": 1680715050880,
"ext": "jpg",
"tags": ["ぼっち", "ろっく"],
"folders": [],
"isDeleted": false,
"url": "https://tw.news.yahoo.com/bocchi-the-rock-071607480.html",
"annotation": "This is an example ;)",
"modificationTime": 1680715050761,
"height": 684,
"width": 960,
"noThumbnail": true,
"palettes": [
{
"color": [196, 172, 154],
"ratio": 33,
"$$hashKey": "object:1775"
},
{
"color": [48, 43, 43],
"ratio": 26,
"$$hashKey": "object:1776"
},
...
{
"color": [225, 204, 205],
"ratio": 2.66,
"$$hashKey": "object:1783"
}
]
}]
```
## Contributor
## License
[MIT](LICENSE)
