A bulk upload library for DocumentCloud.
Project description
A Bulk-Upload Library for DocumentCloud
pneumatic is a Python 3 library that adds some luxury and safeguards to the bulk-uploading of hundreds, thousands or hundreds of thousands of files to DocumentCloud. It is meant to do one thing – upload – and serve as an adjunct to, but not a replacement for, the excellent python-documentcloud API wrapper.
pneumatic’s name is inspired by the pneumatic dispatch systems in newsrooms of yore, which featured a series of pneumatic tubes for sending copy from the newsrooms to other departments such as the composing room.
Features
Catalogs the API response for each upload in a SQLite database along with the file’s canonical URL.
Post-processing, can update the SQLite database with each document’s page count and file hash.
Dumps the SQLite data to a CSV if you wish.
Prevents inadvertent submission of file types DocumentCloud doesn’t handle, such as audio.
Links
Documentation: https://pneumatic.readthedocs.io/en/latest/
Repository: https://github.com/anthonydb/pneumatic
Basic Usage
You will need an active DocumentCloud account and Python 3.5+. First, install via pip:
pip install pneumatic
Example use: To upload all files in a directory (and all sub-directories below it), assign them to an existing project, set the files to public access, and tag each with metadata, run the following code:
from pneumatic import DocumentCloudUploader
uploader = DocumentCloudUploader('person@example.com', 'your-password')
uploader.upload(
file_directory='/govfiles',
project='17477-loudoun-county-government',
access='public',
data={'type': 'government', 'action': 'lawsuit'})
Please see the full documentation for more examples, including how to access the uploads database.
Project details
Release history Release notifications | RSS feed
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 pneumatic-0.1.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5a5693f0fbfe6e228e1a7b83a2198e5cfe2c6395d3a45083f0bce19ebf37c2a |
|
MD5 | 5a5c59c7b85117883fefdd52357679a8 |
|
BLAKE2b-256 | e437d266fa828f49ba002ee14a3dcc3adc1cdaec8da157d233a8877bf1aa9a0e |