dmoonfire/dosage
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Activity

Updated readme

Browse source
This commit is contained in:
Bastian Kleineidam 2013-01-29 18:46:05 +01:00
parent b91603e2a9
commit 28cfede086
1 changed files with 21 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
doc/README.txt
View file

@ -9,8 +9,8 @@ Dosage is designed to keep a local copy of specific webcomics
and other picture-based content such as Picture of the Day sites. and other picture-based content such as Picture of the Day sites.
With the dosage commandline script you can get the latest strip of With the dosage commandline script you can get the latest strip of
webcomic, or catch-up to the last strip downloaded, or download a webcomic, or catch-up to the last strip downloaded, or download a
strip for a particular date/index (except if the webcomic's site layout strip for a particular date/index (if the webcomic's site layout
makes this impossible). makes this possible).
Notice Notice
------- -------
@ -19,11 +19,11 @@ it is purely for personal use. Please be aware that by making downloaded
strips publically available (without the explicit permission of the author) strips publically available (without the explicit permission of the author)
you may be infringing upon various copyrights. you may be infringing upon various copyrights.
Additionally, dosage respects the robots.txt exclusion protocol. This Additionally, Dosage respects the robots.txt exclusion protocol. This
makes sure no content is accessed in an automatic way without consent makes sure no content is accessed in an automatic way without consent
by the publishers. by the publishers.
If you are a publisher of comics and want dosage to access your files, If you are a publisher of comics and want Dosage to access your files,
add the following entry to your robotst.txt file: add the following entry to your robotst.txt file:
``` ```
@ -61,19 +61,16 @@ for example using up to 4 processes:
For advanced options and features execute `dosage -h` or look at the dosage For advanced options and features execute `dosage -h` or look at the dosage
manual page. manual page.
Dependencies
-------------
Python version 2.7 or higher, which can be downloaded
from http://www.python.org/
Also the python-requests module must be installed, which can be downloaded
from http://docs.python-requests.org/en/latest/
Installation Installation
------------- -------------
You can invoke Dosage directly from the source code as "./dosage". Alternatively, The most convenient method is to use pip, which installs all dependencies
you can install Dosage using python distutils by invoking setup.py in automatically:
the root of the distribution. For example:
`pip install dosage`
If you install Dosage from source, the `dosage` script can be run directly with
`./dosage`. Alternatively, you can install Dosage using python distutils by invoking
setup.py in the root of the distribution. For example:
`python setup.py install` `python setup.py install`
@ -81,9 +78,13 @@ or if you do not have root permissions:
`python setup.py install --home=$HOME` `python setup.py install --home=$HOME`
Another option is to use pip: Dependencies
-------------
Python version 2.7 or higher, which can be downloaded
from http://www.python.org/
`pip install dosage` Also the python-requests module is used, which can be downloaded
from http://docs.python-requests.org/en/latest/
Technical Description Technical Description
---------------------- ----------------------
@ -93,9 +94,9 @@ do most of the grunt work.
For each webcomic Dosage has a plugin module, found in the "plugins" For each webcomic Dosage has a plugin module, found in the "plugins"
subdirectory of the dosagelib directory. Each module is a subclass of subdirectory of the dosagelib directory. Each module is a subclass of
the _BasicComic class and specifies where to download its comic images. the _BasicComic class and specifies where to download its comic images.
Some comic syndicates (ucomics for example) have a standard layout for all Some comic syndicates (GoComics for example) have a standard layout for all
comics. For such cases there are general base classes derived from _BasicComic comics. For such cases a generator function creates all _BasicComic class
which help define the plugins for all comics of this syndicate. instances from a given list of comic strips.
Extending Dosage Extending Dosage
----------------- -----------------