view README.txt @ 20:738d84b4de52

start documenting
author Jeff Hammel <jhammel@mozilla.com>
date Wed, 09 Nov 2011 19:55:15 -0800
parents 3fee8ecd1af8
children 81fe0523a078
line wrap: on
line source

fetch
=====

fetch stuff from the interwebs


Format
------

`fetch` fetches from a manifest of the format::

 [URL] [Destination] [Type]

A URL can contain a hash tag (e.g. http://example.com/foo#bar/fleem)
which is used to extract the subdirectories from a multi-directory
resource.

The `Type` of the resource is used to dispatch to the included
Fetchers that take care of fetching the object.  


Fetchers
--------

`fetch` includes several objects for fetching resources::

 file : fetch a single file
 tar : fetch and extract a tarball
 hg : checkout a mercurial repository
 git : checkout a git repository

The `file` fetcher cannot have a hash tag subpath since it is a single
resource.

Though `fetch` has a set of fetchers included, you can pass an
arbitrary list into `fetch.Fetch`'s constructor. 


Version Control
---------------

The `hg` and the `git` fetchers fetch from version control systems and
have additional options.


----

Jeff Hammel
http://k0s.org/mozilla/hg/fetch