Library for downloading scans from a Doxie Go Wi-Fi document scanner
Project description
doxieapi
A Python library for the developer API of the Doxie Go Wi-Fi document scanner.
Installation
doxieapi is available on PyPI: https://pypi.python.org/pypi/doxieapi. Install with pip:
$ pip install doxieapi
Usage
Doxie scanners on the network can discovered automatically using SSDP:
>>> from doxieapi import DoxieScanner
>>> scanners = DoxieScanner.discover()
>>> print(scanners)
[<DoxieScanner: Doxie model DX250 (Doxie_01AFD2) at http://10.0.1.3:8080/>]
Recent and all scans can be listed:
>>> scanner = scanners[0]
>>> scanner.recent
'/DOXIE/JPEG/IMG_0074.JPG'
>>> scanner.scans[:2]
[{'modified': '2010-05-01 00:17:28', 'name': '/DOXIE/JPEG/IMG_0001.JPG', 'size': 1365552},
{'modified': '2010-05-01 00:17:44', 'name': '/DOXIE/JPEG/IMG_0002.JPG', 'size': 1362595}]
Scans can be downloaded individually or all at once:
>>> scanner.download_scan("/DOXIE/JPEG/IMG_0001.JPG", "/tmp")
'/tmp/IMG_0001.JPG'
>>> scanner.download_scans("/tmp")
['/tmp/IMG_0001.JPG', '/tmp/IMG_0002.JPG']
Scans can be deleted too:
>>> scanner.delete_scan("/DOXIE/JPEG/IMG_0001.JPG")
True
>>> scanner.delete_scans([scan['name'] for scan in scanner.scans])
True
Other attributes from the API can be queried:
>>> scanner.firmware
'0.26'
>>> scanner.network
'supersecretwifi'
>>> scanner.name
'Doxie_01AFD2'
>>> scanner.firmware_wifi
'1.29'
You can also run the module directly to download all available scans from all Doxies on the network to the current directory:
$ python -m doxieapi
Discovered Doxie model DX250 (Doxie_01AFD2) at http://10.0.1.3:8080/
Saved /Users/dave/Code/doxieapi/doxieapi/IMG_0001.JPG
Saved /Users/dave/Code/doxieapi/doxieapi/IMG_0002.JPG
Configuration
Connecting to password-protected Doxies is made possible by putting the password for
each scanner in ~/.doxieapi.ini
. Create sections named with the scanner's MAC address,
for example:
[00:11:22:33:44:55]
password=supersecretpassword
Credits
Includes ssdp.py by Dan Krause.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for doxieapi-0.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5637a150d066fc22fdc12b1711ee819317c69993d8a0c41bb75c9b2b58458466 |
|
MD5 | de34c67409ae05522e4ea45cc30daa5a |
|
BLAKE2b-256 | 1e1fd4600c037407b8bb4b75c19f2dd042060eb8fbfc2739339db8f8b2f7b002 |