Skip to main content

Upload documents to Overview web server

Project description

# overview-upload

Upload files to an [Overview]( document set.

# Installation

Requires [python3](

pip3 install overview_upload, maybe with sudo in front. That will install a overview-upload program in your path.

# Command-Line Usage

overview-upload –server <SERVER_URL> –token <API_TOKEN> [options] DIRECTORY

Required arguments:

  • SERVER_URL is the base URL for the server, which defaults to http://localhost:9000 for use with [overview-local](

  • API_TOKEN is required. It’s the access token for a particular document set, which you get like this
    1. Browse to your document set. The URL will look like http://localhost:9000/documentsets/123456.

    2. Note the document set number, in this case 123456

    3. Browse to[your number here]/api-tokens and click “Generate token”.

  • DIRECTORY is a path to the file or directory you want to upload.

Optional arguments:

  • –skip-duplicate (the default), –noskip: skip files that are already part of the document set your API token refers to. Files are compared by their sha1 hashes, meaning even if you move or rename the file it will not be uploaded if the document set already includes it. This feature is helpful for synchronizing a local directory with an Overview document set; however, it will not delete Overview documents corresponding to files you deleted locally.

  • –split-by-page: tell Overview to turn a multi-page file (like a PDF or Word document) into several Overview documents.

  • –ocr (the default), –no-ocr: tell Overview what to do when a PDF page has only images but no text. Overview can either try to recognize text using [Tesseract]( (which is slow and will prevent you from viewing the document set until it finishes), or it can assume the page contains no text.

If you upload a single file, its Overview document title will be its filename, without any directory information. If you upload a directory, filenames will include subdirectory informatin: for instance, if overview-upload /some/path uploads /some/path/to/file.pdf, the Overview document title will be to/file.pdf.

# Developing

## Releasing a new version

  1. Update version in

  2. rm -r dist && ./ bdist && gpg –detach-sign -a dist/*.tar.gz && twine upload/*.tar.gz dist/*.asc

# License

This software is distributed under the terms of the GNU Affero General Public License. See the LICENSE file for details.

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

overview_upload-0.9.0.linux-x86_64.tar.gz (8.3 kB view hashes)

Uploaded Source

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