APIxoo


NameAPIxoo JSON
Version 0.3.1 PyPI version JSON
download
home_pagehttps://github.com/redphx/apixoo
SummaryPython wrapper for Divoom Pixoo server API
upload_time2023-06-24 02:48:33
maintainer
docs_urlNone
authorredphx
requires_python>3.6
licenseMIT
keywords apixoo divoom pixoo pixoo64
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![PyPI](https://img.shields.io/pypi/v/APIxoo?label=PyPI%20Package)](https://pypi.org/project/APIxoo/)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

# APIxoo
Python package to interact with Divoom Pixoo app's server.  
Unlike other packages, this one will only focus on interacting with Divoom Pixoo's server.  
  
For ESP32/Arduino, check [redphx/DivoomClient](https://github.com/redphx/DivoomClient). 

## Features
- [x] Login
- [x] Decode Divoom's animation formats to GIFs (16x16, 32x32, 64x64).  
- [x] Get animation by ID
- [x] Get animations by Category
- [x] Get animations by Album
- [ ] Get animations by User
- [ ] Search animations & users
- [ ] Like/Dislike animation
- [ ] Comment on animation
- [ ] Upload animations

## Install
```
pip install APIxoo
```

## Example
```python
from apixoo import APIxoo, GalleryCategory, GalleryDimension

# Divoom account
EMAIL = 'em@il.com'
MD5_PASSWORD = 'deadc0ffee...'

# Also accept password string with "password='password'"
api = APIxoo(EMAIL, md5_password=MD5_PASSWORD)
status = api.log_in()
if not status:
    print('Login error!')
else:
    files = api.get_category_files(
        GalleryCategory.RECOMMEND,
        dimension=GalleryDimension.W64H64,
        page=1,
        per_page=20,
    )

    for info in files:
        print(info)
        pixel_bean = api.download(info)
        if pixel_bean:
            pixel_bean.save_to_gif(f'{info.gallery_id}.gif', scale=5)
```

*To be updated...*  

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/redphx/apixoo",
    "name": "APIxoo",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">3.6",
    "maintainer_email": "",
    "keywords": "apixoo,divoom,pixoo,pixoo64",
    "author": "redphx",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/b7/84/6b1b9a50030b5740df95ab72094cda7ef1dc4df80e94b734aa0737bf537e/APIxoo-0.3.1.tar.gz",
    "platform": "any",
    "description": "[![PyPI](https://img.shields.io/pypi/v/APIxoo?label=PyPI%20Package)](https://pypi.org/project/APIxoo/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n\n# APIxoo\nPython package to interact with Divoom Pixoo app's server.  \nUnlike other packages, this one will only focus on interacting with Divoom Pixoo's server.  \n  \nFor ESP32/Arduino, check [redphx/DivoomClient](https://github.com/redphx/DivoomClient). \n\n## Features\n- [x] Login\n- [x] Decode Divoom's animation formats to GIFs (16x16, 32x32, 64x64).  \n- [x] Get animation by ID\n- [x] Get animations by Category\n- [x] Get animations by Album\n- [ ] Get animations by User\n- [ ] Search animations & users\n- [ ] Like/Dislike animation\n- [ ] Comment on animation\n- [ ] Upload animations\n\n## Install\n```\npip install APIxoo\n```\n\n## Example\n```python\nfrom apixoo import APIxoo, GalleryCategory, GalleryDimension\n\n# Divoom account\nEMAIL = 'em@il.com'\nMD5_PASSWORD = 'deadc0ffee...'\n\n# Also accept password string with \"password='password'\"\napi = APIxoo(EMAIL, md5_password=MD5_PASSWORD)\nstatus = api.log_in()\nif not status:\n    print('Login error!')\nelse:\n    files = api.get_category_files(\n        GalleryCategory.RECOMMEND,\n        dimension=GalleryDimension.W64H64,\n        page=1,\n        per_page=20,\n    )\n\n    for info in files:\n        print(info)\n        pixel_bean = api.download(info)\n        if pixel_bean:\n            pixel_bean.save_to_gif(f'{info.gallery_id}.gif', scale=5)\n```\n\n*To be updated...*  \n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python wrapper for Divoom Pixoo server API",
    "version": "0.3.1",
    "project_urls": {
        "Download": "https://github.com/redphx/apixoo",
        "Homepage": "https://github.com/redphx/apixoo"
    },
    "split_keywords": [
        "apixoo",
        "divoom",
        "pixoo",
        "pixoo64"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6f19172f127c1d7493d0c62999320bab0bd3ef09a1463d11063ca37d63bbe816",
                "md5": "1515c52460fc0672a286089cc72d2393",
                "sha256": "6c19fbe18c3a5c42d23ced548df2e1893d6a0e6f6f101a1d8990afa4cf7621eb"
            },
            "downloads": -1,
            "filename": "APIxoo-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1515c52460fc0672a286089cc72d2393",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">3.6",
            "size": 9739,
            "upload_time": "2023-06-24T02:48:31",
            "upload_time_iso_8601": "2023-06-24T02:48:31.880837Z",
            "url": "https://files.pythonhosted.org/packages/6f/19/172f127c1d7493d0c62999320bab0bd3ef09a1463d11063ca37d63bbe816/APIxoo-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b7846b1b9a50030b5740df95ab72094cda7ef1dc4df80e94b734aa0737bf537e",
                "md5": "41222ed673f764c791e818d8a6198312",
                "sha256": "053fab31b924c8f6231b92232e6ba14cbdf8fac088746bd65687e35fcee9ea56"
            },
            "downloads": -1,
            "filename": "APIxoo-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "41222ed673f764c791e818d8a6198312",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">3.6",
            "size": 8725,
            "upload_time": "2023-06-24T02:48:33",
            "upload_time_iso_8601": "2023-06-24T02:48:33.149334Z",
            "url": "https://files.pythonhosted.org/packages/b7/84/6b1b9a50030b5740df95ab72094cda7ef1dc4df80e94b734aa0737bf537e/APIxoo-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-24 02:48:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "redphx",
    "github_project": "apixoo",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "apixoo"
}
        
Elapsed time: 2.57770s