Skip to content

Commit 80ec9ea

Browse files
committed
Update test, install commands and README
1 parent 7a626a6 commit 80ec9ea

6 files changed

+53
-67
lines changed

Makefile

+13-10
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,21 @@ debug:
99
inspect:
1010
coverage run --source=amt -m unittest -v $(TEST_ARGS)
1111

12-
quick-test:
13-
QUICK=1 coverage run --source=amt -m unittest --buffer $(TEST_ARGS)
12+
quick_test_coverage: export QUICK=1
13+
quick_test_coverage: test
14+
coverage report --omit "*test*,*server*,*tracker*,amt/util/decoder.py" --fail-under=100 --skip-empty -m
1415

15-
coverage:
16+
full_test_coverage: test
17+
coverage report --omit "*test*,amt/trackers/*,$$(grep login -l amt/servers/*.py | sed -z 's/\n/,/g')" --fail-under=100 --skip-empty -m
18+
coverage report --omit "*test*" --fail-under=95 --skip-empty
19+
20+
coverage_html:
1621
coverage html
1722

1823
install:
19-
install -m 0744 -Dt "$(DESTDIR)/usr/lib/python3.9/$(APP_NAME)" $(APP_NAME)/*.py
20-
install -m 0744 -Dt "$(DESTDIR)/usr/lib/python3.9/$(APP_NAME)/servers" $(APP_NAME)/servers/*.py
21-
install -m 0744 -Dt "$(DESTDIR)/usr/lib/python3.9/$(APP_NAME)/trackers" $(APP_NAME)/trackers/*.py
22-
install -m 0744 -Dt "$(DESTDIR)/usr/lib/python3.9/$(APP_NAME)/util" $(APP_NAME)/util/*.py
23-
install -D -m 0755 main.py "$(DESTDIR)/usr/bin/amt"
24+
python setup.py install "--root=$(DESTDIR)/"
25+
install -D -m 0755 main.py "$(DESTDIR)/usr/bin/$(APP_NAME)"
26+
2427
uninstall:
25-
rm -rdf "$(DESTDIR)/usr/lib/python3.9/site-packages/$(APP_NAME)"
26-
rm -f "$(DESTDIR)/usr/bin/amt"
28+
rm -rdf "$(DESTDIR)"/usr/lib/python*/site-packages/"$(APP_NAME)"
29+
rm -f "$(DESTDIR)/usr/bin/$(APP_NAME)"

README.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
11
#Anime Manga Tracker (beta)
2-
Cli tool to download/stream anime/manga from (mainly) official sources
2+
CLI tool to download/stream anime/manga from (mainly) official sources
33

44
The goal is to provide an simple and unobtrusive way to consume manga/anime using custom players.
55

66

77
## Dependencies
8-
See [requirements.txt](requirements.txt)
8+
See [requirements.txt](requirements.txt) and [requirements-optional.txt](requirements-optional.txt)
99

10-
The hard requirements are the python modules `requests` and `beautifulsoup4`. If some other packages are installed, then some servers are disabled
10+
The hard requirements are the python modules `requests`. If some of the other packages are not installed, then some servers are disabled.
1111

1212
This program also relies on some external tools like `mpv` and `zathura` but other tools can be specified in settings. Similarly `tpm` is used by default but can also be replaced.
13+
1314
## Install
1415
```
1516
make install
1617
```
18+
1719
## Key commands
1820
The general flow is to add a series to AMT, `update` if needed, then use `play` to play the next episode of an anime or `bundle` and `read` to download an assimilate all unread chapters and then read them
1921
* add-from-url -- adds a series based on the series home page (for when searching isn't available)
20-
* bundle -- download all unread chapters and compile them into one file
22+
* bundle -- download all unread manga chapters and compile them into one file
23+
* list -- list all added media
2124
* load -- load saved anime/manga from trackers
22-
* play -- play an episode of an anime
25+
* play/view -- play the next episode of an anime or view the next chapter of manga/light novel
2326
* read -- read a previously created bundle
2427
* search -- search for a title by name
2528
* stream -- stream an anime by url (whatever url you'd use to watch in a browser)
@@ -39,8 +42,8 @@ The general flow is to add a series to AMT, `update` if needed, then use `play`
3942
* [J Novel club](https://j-novel.club/)
4043
* [MangaPlus](https://mangaplus.shueisha.co.jp)
4144
* [Viz](http://viz.com)
42-
* mangasee (unofficial)
43-
* mangadex (unofficial)
45+
* [MangaSee](mangasee123.com/) (unofficial)
46+
* [MangaDex](mangadex.org/) (unofficial)
4447

4548
### Anime
4649
* [Animelab](https://animelab.com/) (WIP)
@@ -65,8 +68,8 @@ There didn't seem to be adequate alternatives that had the following features
6568
* No GUI
6669

6770
## Caveats
68-
* Images with vastly different resolution don't show up ideally in zathura. Bundling one server at a time and using a official sources mitigates the problem.
69-
* Crunchyoll "seasons" don't aren't in sync with the actual seasons. For Non-consecutive cours may or may not be reported as 1 season. Long running series like One Piece and Gintama are broken into seasons arbitrary. This would only affect tracking and can be mitigatred with the "offset" command
71+
* Images with vastly different resolution don't show up ideally in zathura.
72+
* Crunchyoll's (and possible others') "seasons" don't aren't in sync with the actual seasons. For Non-consecutive cours may or may not be reported as 1 season. Long running series like One Piece and Gintama are broken into seasons arbitrary. This would only affect tracking and can be mitigated with the "offset" command
7073

7174
## Similar Projects
7275
* [youtube-dl](https://github.com/ytdl-org/youtube-dl)

amt/TODO

-32
This file was deleted.

requirements-optional.txt

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# needed for many servers including Funimation and Viz
2+
beautifulsoup4
3+
4+
# for auto complete
5+
argcomplete
6+
7+
# Needed for Viz and JnovelClubMangaParts
8+
Pillow
9+
10+
# Needed for downloading Crunchyroll Anime
11+
m3u8
12+
pycryptodome
13+
14+
# Needed mangasee
15+
cloudscraper
16+
17+
# Needed for Vrv
18+
requests_oauthlib

requirements.txt

-16
Original file line numberDiff line numberDiff line change
@@ -1,17 +1 @@
11
requests
2-
# needed for many servers including Funimation and Viz
3-
beautifulsoup4
4-
# for auto complete
5-
argcomplete
6-
7-
# Needed for Viz
8-
Pillow
9-
10-
# Needed for downloading Crunchyroll Anime
11-
m3u8
12-
13-
# Needed for a good experience with Funimation
14-
selenium[browser]
15-
16-
# Needed mangasee
17-
selenium[browser]

setup.py

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
from distutils.core import setup
3+
4+
setup(name="amt",
5+
author="Arthur Williams",
6+
description="Anime/Manga/Novel viewer/tracker",
7+
packages=["amt", "amt/servers", "amt/trackers", "amt/util"],
8+
url="https://github.com/TAAPArthur/amt",
9+
version=".9",
10+
)

0 commit comments

Comments
 (0)