Skip to main content

ArchiveTeam seesaw kit

Project description

Seesaw toolkit
==============

An asynchronous toolkit for distributed web processing. Written in Python and named after its behavior, it supports concurrent downloads, uploads, etc.

This toolkit is well-known for [Archive Team projects](http://archiveteam.org). It also powers the [Archive Team warrior](http://archiveteam.org/index.php?title=Warrior).

[![Build Status](https://secure.travis-ci.org/ArchiveTeam/seesaw-kit.png)](http://travis-ci.org/ArchiveTeam/seesaw-kit)


Installation
------------

Requires Python 2 or 3.

Needs the Tornado library for event-driven I/O. The complete list of Python modules needed are listed in requirements.txt.


How to try it out
-----------------

To run the example pipeline:

sudo pip install -r requirements.txt
./run-pipeline --help
./run-pipeline examples/example-pipeline.py someone

Point your browser to `http://127.0.0.1:8001/`.

You can also use `run-pipeline2` or `run-pipeline3` to be explicit for the Python version.


Overview
--------

General idea: a set of `Task`s that can be combined into a `Pipeline` that processes `Item`s:

* An `Item` is a thing that needs to be downloaded (a user, for example). It has properties that are filled by the `Task`s.
* A `Task` is a step in the download process: it takes an item, does something with it and passes it on. Example Tasks: getting an item name from the tracker, running a download script, rsyncing the result, notifying the tracker that it's done.
* A `Pipeline` represents a sequence of `Task`s. To make a seesaw script for a new project you'd specify a new `Pipeline`.

A `Task` can work on multiple `Item`s at a time (e.g., multiple Wget downloads). The concurrency can be limited by wrapping the task in a `LimitConcurrency` `Task`: this will queue the items and run them one-by-one (e.g., a single Rsync upload).

The `Pipeline` needs to be fed empty `Item` objects; by controlling the number of active `Item`s you can limit the number of items. (For example, add a new item each time an item leaves the pipeline.)

With the `ItemValue`, `ItemInterpolation` and `ConfigValue` classes it is possible to pass item-specific arguments to the `Task` objects. The value of these objects will be re-evaluated for each item. Examples: a path name that depends on the item name, a configurable bandwidth limit, the number of concurrent downloads.

Consult [the wiki](https://github.com/ArchiveTeam/seesaw-kit/wiki) for more information.

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

seesaw-0.8.tar.gz (113.2 kB view details)

Uploaded Source

Built Distribution

seesaw-0.8-py2.7.egg (175.8 kB view details)

Uploaded Egg

File details

Details for the file seesaw-0.8.tar.gz.

File metadata

  • Download URL: seesaw-0.8.tar.gz
  • Upload date:
  • Size: 113.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for seesaw-0.8.tar.gz
Algorithm Hash digest
SHA256 485003154220335d7f9f8a5d63acb2d720001314d0d4e8f2035840ec72896904
MD5 d026e95e92ffa7dfec7f5fbf6a75c8c6
BLAKE2b-256 33532ad37617df4063d1bad80289021e0ec0f49fa8cb43e0335ebf1c93a7184c

See more details on using hashes here.

File details

Details for the file seesaw-0.8-py2.7.egg.

File metadata

  • Download URL: seesaw-0.8-py2.7.egg
  • Upload date:
  • Size: 175.8 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for seesaw-0.8-py2.7.egg
Algorithm Hash digest
SHA256 aab289c8805061589fc0c64c5ab445ff9ad6c70672d48972b90795fca70b511e
MD5 5ea0e3515da2f814897e6f65e8f70126
BLAKE2b-256 3564aa1173ec39bcb56db2657e2c9af4914c843289f8664aecce085a0f02069e

See more details on using hashes here.

Supported by

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