Skip to content

Commit 3df8c82

Browse files
committed
Lift to version v0.5.0, update README
1 parent e3f9d9d commit 3df8c82

File tree

2 files changed

+38
-12
lines changed

2 files changed

+38
-12
lines changed

Diff for: README.md

+37-11
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ Not living in Japan has me not really having any readable access of weekly chapt
1111

1212
M2em let's you automatically download Mangas via RSS Feed that updates at a configurable interval (and comics in the future?), convert them into eMangas and send them off via Email (Target being the Email to Kindle function of Amazon)!
1313

14+
## Supported Websites
15+
16+
* Mangastream
17+
* MangaFox
18+
* Cdmnet
19+
1420
# Setup
1521

1622
M2em requires Python3 and I highly recommend working in a virtualenv. Some OS require the python-dev package!
@@ -39,6 +45,24 @@ deactivate
3945

4046
Get Kindlegen here: https://www.amazon.com/gp/feature.html?docId=1000765211
4147

48+
## Docker Setup
49+
You can use the Dockerfile or the image schemen/m2em. All options in the config.ini are available as environment variable. Make sure you write the exactly the same!
50+
51+
Example Compose file:
52+
```
53+
version: '2'
54+
services:
55+
m2em:
56+
image: schemen/m2em:latest
57+
environment:
58+
- SMTPServer=mail.example.com
59+
60+
- EmailAddressPw=verysecurepassword
61+
volumes:
62+
- <DATA_DIRECTORY>:/usr/src/app/data
63+
64+
```
65+
4266
## Concept
4367
As a concept, M2em has different workers that run in a loop. All Chapter/user data is saved in a SQLite3 Database.
4468
* RssParser - Parsing the RSS feed and saving the information of each chapter
@@ -64,15 +88,16 @@ Example: if you wish to download all chapters you have saved in your database, y
6488
You can directly apply an action to one chapter with the options --download, --convert or --send. You need to pass
6589
the ID of said chapter, you can find that out with "-Lc" or "-lc".
6690
You can pass multiple IDs.
67-
Example:
91+
92+
Also, you can process N chapters with the "--process/-p" option:
6893
```
69-
./m2em.py --download 100 #Downloads chapter with ID 100
94+
./m2em.py -p 100 #Downloads, Converts and Sends chapter with ID 100
7095
```
7196

7297

73-
## Supported Websites
74-
* Mangastream
75-
* MangaFox
98+
```
99+
./m2em.py --download 100 #Downloads chapter with ID 100
100+
```
76101

77102
# Usage
78103

@@ -81,9 +106,10 @@ Example:
81106
usage: m2em.py [-h] [-af ADD_FEED] [-au] [-lm [LIST_MANGA]] [-lc] [-Lc] [-lf]
82107
[-lu] [-cd] [-s] [--send [SEND [SEND ...]]]
83108
[--convert [CONVERT [CONVERT ...]]]
84-
[--download [DOWNLOAD [DOWNLOAD ...]]] [-a ACTION]
85-
[-ss SWITCH_SEND] [-sc SWITCH_CHAPTER] [-dc DELETE_CHAPTER]
86-
[-du DELETE_USER] [-df DELETE_FEED] [--daemon] [-d] [-v]
109+
[--download [DOWNLOAD [DOWNLOAD ...]]]
110+
[-p [PROCESS [PROCESS ...]]] [-a ACTION] [-ss SWITCH_SEND]
111+
[-dc DELETE_CHAPTER] [-du DELETE_USER] [-df DELETE_FEED]
112+
[--daemon] [-d] [-v]
87113
88114
Manga to eManga - m2em
89115
@@ -112,13 +138,14 @@ optional arguments:
112138
--download [DOWNLOAD [DOWNLOAD ...]]
113139
Downloads Chapter directly by chapter ID. Multiple IDs
114140
can be given
141+
-p [PROCESS [PROCESS ...]], --process [PROCESS [PROCESS ...]]
142+
Processes chapter(s) by chapter ID, Download, convert,
143+
send. Multiple IDs can be given
115144
-a ACTION, --action ACTION
116145
Start action. Options are: rssparser (collecting feed
117146
data), downloader, converter or sender
118147
-ss SWITCH_SEND, --switch-send SWITCH_SEND
119148
Pass ID of User. Switches said user Send eBook status
120-
-sc SWITCH_CHAPTER, --switch-chapter SWITCH_CHAPTER
121-
Pass ID of Chapter. Switches said Chapter Sent status
122149
-dc DELETE_CHAPTER, --delete-chapter DELETE_CHAPTER
123150
Pass ID of Chapter. Deletes said Chapter
124151
-du DELETE_USER, --delete-user DELETE_USER
@@ -203,7 +230,6 @@ If you wish to disable/enable sending status of a user, use the -ss command
203230
```
204231

205232

206-
207233
### A complete run with nothing happening:
208234
```
209235
Starting Loop at 2017-11-15 18:13:05

Diff for: bin/_version.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "v0.4.0"
1+
__version__ = "v0.5.0"

0 commit comments

Comments
 (0)