Welcome to Hypershot’s documentation!

The hypershot command line tool creates screen shots of a video file, and uploads them to an image host. You can also upload existing images, using the same configuration as for the screen shots.

Demo Terminal Session

This manual is separated into these chapters, they should be read in order:

• Introduction describes what hypershot can do for you in more detail.
• Installation shows how the application itself and necessary tools are installed.
• Configuration explains how you can add image hosting services and other custom settings.
• Read Usage to learn about the different ways to call the hypershot command.
• If you want to add your own result templates, consult Templating of Upload Results for details.
• The Changelog is a timeline of the project’s history, check this after an update for new features and other relevant changes.

If you’re a developer, see the GitLab README for some information on working with the source code.

Warning

This project is under development, and not all features described here are implemented yet. So do not be surprised if you just get an error message when you try some things.

Consult the Changelog regarding the implementation progress.

Detailed Contents

• Introduction
  • What it Does
  • How it Works
• Installation
  • Installing the Python Application
  • Installing Tools
• Configuration
  • Configuration File
  • Image Hosters
    • imgur
    • Simple File Upload Sites
    • Chevereto Sites
  • Logging Configuration
• Usage
  • Common Options
  • Generating and Uploading Screen Shots
  • Uploading Existing Images
• Templating of Upload Results
  • Templating Introduction
  • Writing Custom Templates
• Changelog

Indices & Tables

• Index
• Module Index
• Search Page