Browse Source

Update README, add requirements, add env

Christoph Stelz 3 years ago
parent
commit
4432b58c50
3 changed files with 33 additions and 0 deletions
  1. 30 0
      README.md
  2. 2 0
      requirements.txt
  3. 1 0
      zeitdownload.py

+ 30 - 0
README.md

@@ -0,0 +1,30 @@
+# Die ZEIT Downloader
+
+This is a simple downloader for the digital formats of the weekly newspaper [Die Zeit](https://www.zeit.de). A digital subscription is required.
+It is written in only 70 lines of python
+
+[![asciicast](https://asciinema.org/a/2Eg8PPKI47iFGxRYFP8Kigqz3.svg)](https://asciinema.org/a/2Eg8PPKI47iFGxRYFP8Kigqz3)
+
+## Installation
+
+1. Clone this repo or download the `zeitdownload.py`.
+2. Make sure the requirements are installed:
+    * `sudo pip3 install -r requirements.txt`
+3. Run with `./zeitdownload.py`.
+
+## Documentation
+
+```
+usage: zeitdownload.py [-h] --email EMAIL --password PASSWORD [--pdf] [--epub]
+                       [--mobi]
+
+Download "Die Zeit" in multiple formats from the premium subscription service
+
+optional arguments:
+  -h, --help           show this help message and exit
+  --email EMAIL        Email you used for the digital subscription signup
+  --password PASSWORD  Corresponding password
+  --pdf                Download full-page PDF
+  --epub               Download EPUB file for E-Readers
+  --mobi               Download MOBI file for Kindles
+```

+ 2 - 0
requirements.txt

@@ -0,0 +1,2 @@
+requests
+lxml

+ 1 - 0
zeitdownload.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 import requests
 import lxml.html
 import cgi