Skip to main content

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.

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pneumatic-0.1.9.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

pneumatic-0.1.9-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file pneumatic-0.1.9.tar.gz.

File metadata

  • Download URL: pneumatic-0.1.9.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.1

File hashes

Hashes for pneumatic-0.1.9.tar.gz
Algorithm Hash digest
SHA256 12dfde8e9663e92057f24c167a3e9547a32884d7aeedd25aff9dac789fa48c6c
MD5 c26c11d5bacda4f8cb6c66d016857478
BLAKE2b-256 526f05cd07abc0039f8e577c673d10efd62ed1885c3b5ca840ab8233c1670614

See more details on using hashes here.

File details

Details for the file pneumatic-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: pneumatic-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 10.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.1

File hashes

Hashes for pneumatic-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 e5a5693f0fbfe6e228e1a7b83a2198e5cfe2c6395d3a45083f0bce19ebf37c2a
MD5 5a5c59c7b85117883fefdd52357679a8
BLAKE2b-256 e437d266fa828f49ba002ee14a3dcc3adc1cdaec8da157d233a8877bf1aa9a0e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page