Animanager Documentation Release 0.8.0
Total Page:16
File Type:pdf, Size:1020Kb
Animanager Documentation Release 0.8.0 Allen Li March 26, 2016 Contents 1 Installation and configuration3 1.1 pip/PyPi installation...........................................3 1.2 Manual installation............................................3 1.3 Database setup..............................................3 1.4 Configuration...............................................4 2 Quickstart 5 2.1 Adding a series..............................................5 2.2 Searching your database.........................................6 2.3 Watching shows.............................................6 2.4 View stats.................................................7 2.5 Other features..............................................7 3 Configuration 9 4 Command reference 11 4.1 Global options.............................................. 11 4.2 Anime commands............................................ 11 4.3 Manga commands............................................ 15 5 Database format 17 5.1 Manga support.............................................. 17 5.2 More information............................................. 17 6 Selection menus 19 7 Indices and tables 23 i ii Animanager Documentation, Release 0.8.0 Project website: https://darkfeline.github.io/animanager/ This is the documentation for Animanager. Animanager is a simple anime watching and tracking program. Contents 1 Animanager Documentation, Release 0.8.0 2 Contents CHAPTER 1 Installation and configuration 1.1 pip/PyPi installation Animanager can be installed fairly easily using pip: $ pip3 install --user animanager You need Python 3, pip for Python 3, and setuptools for this. Other dependencies will be installed automatically. 1.2 Manual installation You need the following dependencies to run Animanager: • Python 3 • setuptools • tabulate Python 3 is needed to run Animanager. setuptools is neede for handling the installation. tabulate is needed for printing pretty tables (e.g., anime search). tabulate can be installed with pip: $ pip3 install --user tabulate Animanager can be installed manually: $ python3 setup.py install --user 1.3 Database setup Load the included database schema schema.sql into a SQLite3 database file at ~/.animanager/database.db: $ sqlite3 ~/.animanager/database.db '.read schema.sql' 3 Animanager Documentation, Release 0.8.0 1.4 Configuration Copy the included configuration file config.ini to ~/.animanager/config.ini. Read the file and edit it accordingly. You will definitely need to edit the credentials for logging into MyAnimeList (MAL). This is used to pull information using MAL’s API. You may want to edit the player line to configure which video player to use. Examples: player= mpv--fullscreen player= mplayer The [series] section is described in detail elsewhere; you do not need to touch it right now. 4 Chapter 1. Installation and configuration CHAPTER 2 Quickstart This guide provides an example of basic Animanager usage. 2.1 Adding a series First, add a series to track: $ animanager anime add "hidamari sketch" Animanager will search MAL for series: 0: (1852) Hidamari Sketch 1: (3165) Hidamari Sketch Specials 2: (3604) Hidamari Sketch x 365 3: (6984) Hidamari Sketch x 365 Specials 4: (7062) Hidamari Sketch x 5: (9563) Hidamari Sketch x Specials 6: (11237) Hidamari Sketch x SP 7: (11239) Hidamari Sketch x Honeycomb 8: (17739) Hidamari Sketch: Sae Hiro Sotsugyou-hen 9: (20391) Hidamari Sketch: Chou Hidamatsuri Special 10: (28911) Hidamari Sketch Recap 11: (28913) Hidamari Sketch x 365 Recap 12: (28915) Hidamari Sketch x Recap [-1]> This is Animanager’s selection interface, which you will see a lot. The [-1] means the default choice is -1, or the last item (in this case, 12). Another common default is [0], which indicates the first item. You can pick an item by typing its number and pressing Enter, or simply press Enter to pick the default choice. Next, choose the initial status: 0: plan to watch 1: watching 2: complete [0]> For this guide, here we pick watching. 5 Animanager Documentation, Release 0.8.0 2.2 Searching your database We can search our database to check our information: $ animanager anime search hidamari id name type ep_watched ep_total status date_started date_finished animedb_id ---- ------------------------ ------- ------------ ---------- -------- -------------- --------------- ------------ 1 Hidamari Sketch x 365 TV 0 13 watching 3604 This shows all of the information Animanager tracks. 2.3 Watching shows Navigate to the directory where your files are: $ cd anime $ ls [SpoonSubs] Hidamari Sketch x 365 - 01 (DVD).mkv [SpoonSubs] Hidamari Sketch x 365 - 02 (DVD).mkv [SpoonSubs] Hidamari Sketch x 365 - 03 (DVD).mkv [SpoonSubs] Hidamari Sketch x 365 - 04 (DVD).mkv [SpoonSubs] Hidamari Sketch x 365 - 05 (DVD).mkv [SpoonSubs] Hidamari Sketch x 365 - 06 (DVD).mkv [SpoonSubs] Hidamari Sketch x 365 - 06 (DVD).mkv [SpoonSubs] Hidamari Sketch x 365 - 07 (DVD).mkv [SpoonSubs] Hidamari Sketch x 365 - 08 (DVD).mkv [SpoonSubs] Hidamari Sketch x 365 - 09 (DVD).mkv [SpoonSubs] Hidamari Sketch x 365 - 09 (DVD).mkv [SpoonSubs] Hidamari Sketch x 365 - 10 (DVD).mkv [SpoonSubs] Hidamari Sketch x 365 - 11 (DVD).mkv [SpoonSubs] Hidamari Sketch x 365 - 12 (DVD).mkv [SpoonSubs] Hidamari Sketch x 365 - 13 (DVD).mkv Now we can use Animanager to automatically watch our series: $ animanager anime watch 0: (900) Hidamari Sketch x 365 (cur. 0, avail. 13) [-1]> Animanager presents the choices for series to watch. Right now we only have one series, but we can add multiple and they will appear here provided that episodes are available. We see that we have currently watched no episodes and have 13 available to watch. Press Enter to select the default and only choice. Your configured video player will start and you can watch the episode. After the episode is over, the video player will close (provided that you are using an mpv-like player): Bump? [Y/n] Animanager will prompt whether you want to bump your currently watched episode count. The default is yes, so just hit Enter. Alternatively, you can type n to keep your currently watched episode at 0. Animanager will automatically move the file to a “trash” directory to clean up the working directory. Now we’re back at the menu: 0: (900) Hidamari Sketch x 365 (cur. 1, avail. 12) [-1]> 6 Chapter 2. Quickstart Animanager Documentation, Release 0.8.0 You can keep watching, or quit using CTRL-C. We quit to continue the tutorial. Let’s check our database: $ animanager anime search hidamari id name type ep_watched ep_total status date_started date_finished animedb_id ---- ------------------------ ------- ------------ ---------- -------- -------------- --------------- ------------ 1 Hidamari Sketch x 365 TV 1 13 watching 2015-09-29 3604 The episode count has been updated automatically, and the start date has been set as well. 2.4 View stats Just for fun, Animanager also lets you view basic statistics: $ animanager anime stats By status: - complete: 638 - on hold: 0 - dropped: 165 - watching: 22 - plan to watch: 61 Total: 886 Episodes watched: 8715 2.5 Other features Here’s an overview of some of Animanager’s features: • Version detection. Animanager will delete older versions of an episode and watch the latest version. • Date tracking of when you started and finished a series. • Updating series data via MAL (for example, if the total number of episodes for a series changes). I highly recommend you read through all of the documentation, which contains more information about Animanager’s features. 2.4. View stats 7 Animanager Documentation, Release 0.8.0 8 Chapter 2. Quickstart CHAPTER 3 Configuration Animanager uses a configuration file in INI format. The default path of the file is ~/.animanager/config.ini, but can also be supplied as an option in the command line. See the included config.ini file for documentation and defaults. 9 Animanager Documentation, Release 0.8.0 10 Chapter 3. Configuration CHAPTER 4 Command reference 4.1 Global options These go before any commands. --config=PATH Specify an alternate configuration file to use. Default is ~/.animanager/config.ini. --db=PATH Specify an alternate database file to use. Default is ~/.animanager/database.db. Make judicious use of the --help option: $ animanager --help $ animanager anime --help $ animanager anime add --help 4.2 Anime commands These commands track and manage anime: $ animanager anime <command> I suggest you make an alias for your shell; for Bash, put this in your .bashrc: alias anime="animanager anime" 4.2.1 add $ animanager anime add "series name search" Add a series. You provide a string to search for, Animanager will search for it on MAL and prompt you for a series to add. You can add it with an initial status of “plan to watch”, “watching”, or “finished”. In the case of “finished”, Animanager will also set the watched episode count, and ask if you want to set the start and finished dates to today. In the case of “watching”, Animanager will also register the show (see register). 11 Animanager Documentation, Release 0.8.0 4.2.2 bump $ animanager anime bump "series name search" Animanager will selectively bump the episode watched count of one show. By default Animanager will only search “watching” shows; use the option --all to search from all incomplete shows. Animanager will set the show to watching, update start and end date, and update completion status automagically. 4.2.3 clean $ animanager anime clean Cleans up registered series in the config (see register). Removes all registered series in the config file that have been completed or dropped. 4.2.4 drop $ animanager anime drop "series name