box21-api

Name	box21-api JSON
Version	0.0.17 JSON
	download
home_page	https://github.com/ramonhollands/box21_api
Summary	Api for Box21.ai
upload_time	2025-03-03 14:36:10
maintainer	None
docs_url	None
author	Ramon
requires_python	>=3.7
license	Apache Software License 2.0
keywords	nbdev jupyter notebook python
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            box21_api
================

<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

A python package for interacting with your Box21 via the api

## Install

``` sh
pip install box21_api
```

## How to use

``` python
from box21_api.box21_api import Box21Api
```

``` python
box21_api = Box21Api(API_USERNAME, API_PASSWORD, 'https://box21.ai', 443, API_PROJECT_ID)
```

``` python
labels = box21_api.get_labels()
print('Number of labels retrieved', len(labels))
print('First label', labels[0])
```

    Number of labels retrieved 2
    First label Label(('Bounding box', 'Chital', 1))

``` python
annotations = box21_api.get_label_annotations(labels[0])
print('Number of annotations retrieved', len(annotations))
print('First annotation', annotations[0])
```

    Number of annotations retrieved 2
    First annotation BoundingBox(Chital, (0.1641, 0.5291, 0.2766, 0.3381))

``` python
first_annotation = annotations[0]
pil_image = box21_api.download_asset(first_annotation.asset_id)
pil_image
```

![](index_files/figure-gfm/cell-6-output-1.png)

See more examples on: https://ramonhollands.github.io/box21_api/

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ramonhollands/box21_api",
    "name": "box21-api",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "nbdev jupyter notebook python",
    "author": "Ramon",
    "author_email": "ramonhollands@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/96/7c/847e7003f4030660e8589bbb95ed69ef35733e9b9b2e52bde4d2248d0821/box21_api-0.0.17.tar.gz",
    "platform": null,
    "description": "box21_api\n================\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\nA python package for interacting with your Box21 via the api\n\n## Install\n\n``` sh\npip install box21_api\n```\n\n## How to use\n\n``` python\nfrom box21_api.box21_api import Box21Api\n```\n\n``` python\nbox21_api = Box21Api(API_USERNAME, API_PASSWORD, 'https://box21.ai', 443, API_PROJECT_ID)\n```\n\n``` python\nlabels = box21_api.get_labels()\nprint('Number of labels retrieved', len(labels))\nprint('First label', labels[0])\n```\n\n    Number of labels retrieved 2\n    First label Label(('Bounding box', 'Chital', 1))\n\n``` python\nannotations = box21_api.get_label_annotations(labels[0])\nprint('Number of annotations retrieved', len(annotations))\nprint('First annotation', annotations[0])\n```\n\n    Number of annotations retrieved 2\n    First annotation BoundingBox(Chital, (0.1641, 0.5291, 0.2766, 0.3381))\n\n``` python\nfirst_annotation = annotations[0]\npil_image = box21_api.download_asset(first_annotation.asset_id)\npil_image\n```\n\n![](index_files/figure-gfm/cell-6-output-1.png)\n\nSee more examples on: https://ramonhollands.github.io/box21_api/\n",
    "bugtrack_url": null,
    "license": "Apache Software License 2.0",
    "summary": "Api for Box21.ai",
    "version": "0.0.17",
    "project_urls": {
        "Homepage": "https://github.com/ramonhollands/box21_api"
    },
    "split_keywords": [
        "nbdev",
        "jupyter",
        "notebook",
        "python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bfee1261c7b4e27abe942b52368eb1a4835ccaa513a70045bfc50205fc1d8edf",
                "md5": "53bdb74d253d3cc846224aa00cd19d4b",
                "sha256": "4b330fedeb0871721ee917d72bea74ff03c5e103096b57f162198d8d7d197ef5"
            },
            "downloads": -1,
            "filename": "box21_api-0.0.17-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "53bdb74d253d3cc846224aa00cd19d4b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 15434,
            "upload_time": "2025-03-03T14:36:08",
            "upload_time_iso_8601": "2025-03-03T14:36:08.185640Z",
            "url": "https://files.pythonhosted.org/packages/bf/ee/1261c7b4e27abe942b52368eb1a4835ccaa513a70045bfc50205fc1d8edf/box21_api-0.0.17-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "967c847e7003f4030660e8589bbb95ed69ef35733e9b9b2e52bde4d2248d0821",
                "md5": "4f0569fdfabf941d9297517321af94bd",
                "sha256": "41bc8ce9d5f2964357b2fca852b940a805ab2f69b6ea43128c691612d34a0f4e"
            },
            "downloads": -1,
            "filename": "box21_api-0.0.17.tar.gz",
            "has_sig": false,
            "md5_digest": "4f0569fdfabf941d9297517321af94bd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 3192303,
            "upload_time": "2025-03-03T14:36:10",
            "upload_time_iso_8601": "2025-03-03T14:36:10.785592Z",
            "url": "https://files.pythonhosted.org/packages/96/7c/847e7003f4030660e8589bbb95ed69ef35733e9b9b2e52bde4d2248d0821/box21_api-0.0.17.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-03-03 14:36:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ramonhollands",
    "github_project": "box21_api",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "box21-api"
}