pneumatic is a bulk-upload library for DocumentCloud.
Python
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
pneumatic
tests
.gitignore
AUTHORS.rst
CHANGELOG.rst
LICENSE
README.rst
manifest.in
setup.cfg
setup.py

README.rst

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.
  • Dumps the SQLite data to a CSV if you wish.
  • Multiprocessing (under Mac/Linux) for faster submission of files to DocumentCloud's API.
  • Prevents inadvertent submission of file types DocumentCloud doesn't handle, such as audio.

Links

Basic Usage

You will need an active DocumentCloud account and Python 3.4+. 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'})