Repository files navigation

Dosage is designed to keep a local copy of specific webcomics and otherpicture-based content such as Picture of the Day sites. With the dosagecommandline script you can get the latest strip of a webcomic, or catch-up tothe last strip downloaded, or download a strip for a particular date/index (ifthe webcomic's site layout allows this).

Multiple webcomics can be downloaded in parallel, making the update of comicstrips faster.

Dosage is licensed under theMIT license

This software is in no way intended to publically "broadcast" comic strips, itis purely for personal use. Please be aware that by making downloaded stripspublically available (without the explicit permission of the author) you may beinfringing upon various copyrights.

Additionally, Dosage respects the robots.txt exclusion protocol. This makessure no content is accessed in an automatic way without consent by thepublishers.

In any case, you should support the authors of the comics you are downloading,either by buying some of their products or even donating them some money sincethey provide the comics you like and read.

If you are a publisher of comics and want Dosage to access your files,add the following entry to your robots.txt file:

User-agent: DosageAllow: *

List available comics (ca. 3000 at the moment):

$ dosage --list

Get the latest comic of for example CalvinAndHobbes and save it in the "Comics"directory:

$ dosage CalvinAndHobbes

If you already have downloaded several comics and want to get the latest stripof all of them:

$ dosage @

To help others find good comics, you can vote for your favourite ones:

$ dosage --vote @

For advanced options and features executedosage --help.

Some comics contain adult content and require age confirmation. These comicscan only be downloaded by using the--adult option, which confirms that youare old enough to view them.

Since dosage is written inPython, a Pythoninstallation is required: Dosage needs at least Python 3.8. Dosage requiressome Python modules from PyPI, so installation withpip is recommended.

Windows users can download a complete binary (including Python) from therelease page.

The simplest way to install and upgrade dosage is withpipx. To install thenewest stable version with all optional features use:

pipx install dosage[css,bash]

To install the newest development version, use:

pipx install "dosage[css,bash] @ git+https://github.com/webcomics/dosage.git"

To upgrade such installations, just run:

pipx upgrade dosage

If you want to run dosage directly from the source code, you should installit in "editable" mode, preferable in avirtual environment:

pip install -e .[css,bash,dev]

After that,dosage should be available as a normal command.

You can report bugs, patches or requests at theGitHub issuetracker - Dosage currentlysupports a large number of comics and that number grows on a regular basis. Ifyou feel that there are comics that Dosage does not currently support, butshould support, please feel free to request them.

In order to add a new webcomic, a new module class has to be created in one ofthe *.py files in one thedosagelib/plugins subdirectory. Look at thedocumentation for adding modules and atexisting module classes for examples.

Dosage has unit tests to ensure code quality. GitHub Actions are used forcontinuous build and test integration. See the badges at the top of this pagefor the current status.