{
    "info": {
        "author": "Dave Arter",
        "author_email": "pypi@davea.me",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "``doxieapi``\n============\n\nA Python library for the `developer\nAPI <http://help.getdoxie.com/doxiego/advanced/wifi/api/>`__ of the\n`Doxie Go Wi-Fi <http://www.getdoxie.com/product/doxie-go/>`__ document\nscanner.\n\nInstallation\n------------\n\ndoxieapi is available on PyPI: https://pypi.python.org/pypi/doxieapi.\nInstall with pip:\n\n.. code:: sh\n\n    $ pip install doxieapi\n\nUsage\n-----\n\nDoxie scanners on the network can discovered automatically using SSDP:\n\n.. code:: python\n\n    >>> from doxieapi import DoxieScanner\n    >>> scanners = DoxieScanner.discover()\n    >>> print(scanners)\n    [<DoxieScanner: Doxie model DX250 (Doxie_01AFD2) at http://10.0.1.3:8080/>]\n\nRecent and all scans can be listed:\n\n.. code:: python\n\n    >>> scanner = scanners[0]\n    >>> scanner.recent\n    '/DOXIE/JPEG/IMG_0074.JPG'\n    >>> scanner.scans[:2]\n    [{'modified': '2010-05-01 00:17:28', 'name': '/DOXIE/JPEG/IMG_0001.JPG', 'size': 1365552},\n    {'modified': '2010-05-01 00:17:44', 'name': '/DOXIE/JPEG/IMG_0002.JPG', 'size': 1362595}]\n\nScans can be downloaded individually or all at once:\n\n.. code:: python\n\n    >>> scanner.download_scan(\"/DOXIE/JPEG/IMG_0001.JPG\", \"/tmp\")\n    '/tmp/IMG_0001.JPG'\n    >>> scanner.download_scans(\"/tmp\")\n    ['/tmp/IMG_0001.JPG', '/tmp/IMG_0002.JPG']\n\nScans can be deleted too:\n\n.. code:: python\n\n    >>> scanner.delete_scan(\"/DOXIE/JPEG/IMG_0001.JPG\")\n    True\n    >>> scanner.delete_scans([scan['name'] for scan in scanner.scans])\n    True\n\nOther attributes from the API can be queried:\n\n.. code:: python\n\n    >>> scanner.firmware\n    '0.26'\n    >>> scanner.network\n    'supersecretwifi'\n    >>> scanner.name\n    'Doxie_01AFD2'\n    >>> scanner.firmware_wifi\n    '1.29'\n\nYou can also run the module directly to download all available scans\nfrom all Doxies on the network to the current directory:\n\n.. code:: sh\n\n    $ python -m doxieapi\n    Discovered Doxie model DX250 (Doxie_01AFD2) at http://10.0.1.3:8080/\n    Saved /Users/dave/Code/doxieapi/doxieapi/IMG_0001.JPG\n    Saved /Users/dave/Code/doxieapi/doxieapi/IMG_0002.JPG\n\nConfiguration\n-------------\n\nConnecting to password-protected Doxies is made possible by putting the\npassword for each scanner in ``~/.doxieapi.ini``. Create sections named\nwith the scanner's MAC address, for example:\n\n.. code:: ini\n\n    [00:11:22:33:44:55]\n    password=supersecretpassword\n\n",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/davea/doxieapi/",
        "keywords": "doxie document scanner",
        "license": "LICENSE.txt",
        "maintainer": null,
        "maintainer_email": null,
        "name": "doxieapi",
        "package_url": "https://pypi.org/project/doxieapi/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/doxieapi/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://github.com/davea/doxieapi/"
        },
        "release_url": "https://pypi.org/project/doxieapi/0.0.2/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Library for downloading scans from a Doxie Go Wi-Fi document scanner",
        "version": "0.0.2"
    },
    "last_serial": 1918859,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4622dc785f811e4813b6c8ab7eb6f9f5",
                    "sha256": "9b864d3afd6e06305efeec587e582a5aaf185ac5a5cc4dd981f11f0e3fa8f2f1"
                },
                "downloads": -1,
                "filename": "doxieapi-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "4622dc785f811e4813b6c8ab7eb6f9f5",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5111,
                "upload_time": "2016-01-20T22:14:37",
                "url": "https://files.pythonhosted.org/packages/37/3f/0d6b31fccf19c0d8c3d68cccdcbb162c4fb027fab5dcd4e704d75681c927/doxieapi-0.0.1.tar.gz"
            }
        ],
        "0.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "7c95b2e43ef60e4182a547f03f942294",
                    "sha256": "80cd3b9fd8affc62222f9b3cc636620e869e517a626fda808cb521d5100e8859"
                },
                "downloads": -1,
                "filename": "doxieapi-0.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "7c95b2e43ef60e4182a547f03f942294",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5738,
                "upload_time": "2016-01-23T12:21:05",
                "url": "https://files.pythonhosted.org/packages/8c/71/5ef7abc3e376b5bd5df4735099415e31ca045598797a7555431ab50f2a64/doxieapi-0.0.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "7c95b2e43ef60e4182a547f03f942294",
                "sha256": "80cd3b9fd8affc62222f9b3cc636620e869e517a626fda808cb521d5100e8859"
            },
            "downloads": -1,
            "filename": "doxieapi-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "7c95b2e43ef60e4182a547f03f942294",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 5738,
            "upload_time": "2016-01-23T12:21:05",
            "url": "https://files.pythonhosted.org/packages/8c/71/5ef7abc3e376b5bd5df4735099415e31ca045598797a7555431ab50f2a64/doxieapi-0.0.2.tar.gz"
        }
    ]
}