From de8824be2229291d6244ce4f19cb6708e4484d4e Mon Sep 17 00:00:00 2001 From: Michael Johnson <44432163+MichaelDavidJohnson@users.noreply.github.com> Date: Mon, 20 Jul 2020 23:04:47 +0100 Subject: [PATCH] Removed the example of using the watch command and corrected docs. (#444) * Removed watch command. Removed the `anime watch` as an example of how to run the command. * Cleaned up the image, still couldn't get it to embed though * Fixed bottom half of broken English. * Capital letters follow full-stops and don't exist in the middle of sentences. * changed the introduction to have more flow * full-stops shouldn't end lines that continue with lines of code. * Names begin with capital letters. * Removed the info about watch feature.. It doesn't exist * Update README.md * semi-alphabetised * capital letters do not belong in the middle of sentences unless they are names * grammar * sentences that have bulletpoints as part of the sentence require ; * some punctuation * Update config.rst * Update watch.rst * Update sites.rst * Update dl.rst * Update index.rst * Update index.rst --- README.md | 47 +++++++++---------- docs/advanced/custom_site.rst | 8 ++-- docs/advanced/testing.rst | 4 +- docs/index.rst | 32 +++++++++---- docs/usage/api.rst | 8 ++-- docs/usage/config.rst | 6 +-- docs/usage/dl.rst | 15 +++--- docs/usage/installation.rst | 86 ++++++++++++++++------------------- docs/usage/sites.rst | 2 +- docs/usage/watch.rst | 2 +- 10 files changed, 107 insertions(+), 103 deletions(-) diff --git a/README.md b/README.md index 2cc99f0..fb97692 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,6 @@ Yeah. Me too! That's why this tool exists. - Specify the quality you want to stream or download. - Search and download. - Save yourselves from those malicious ads. -- Add any anime to your watch list using `anime watch` and let anime downloader take care of everything for you. - Download using external downloader ([aria2](https://aria2.github.io/) recommended). - Configurable using `config.json`. See [documentation](https://anime-downlader.readthedocs.io/en/latest/usage/config.html). @@ -52,41 +51,43 @@ Yeah. Me too! That's why this tool exists. ## Supported Sites **Details about the sites can be found in [FAQ](https://github.com/vn-ki/anime-downloader/wiki/FAQ)** + +- a2zanime - Anistream - AnimeOnline360 - Animeflix - Animefreak -- Gogoanime -- Dubbedanime -- a2zanime - animeout -- itsaturday - Animeflv -- Kickassanime -- DreamAnime -- RyuAnime -- Erai-Raws +- AnimeKisa - Animesimple - Animerush -- Watchmovie -- Nyaa.si - Animedaisuki -- Justdubs +- Animixplay +- Animepahe - requires Node.js - Animevibe -- Yify +- DreamAnime +- Dubbedanime +- Erai-Raws +- Gogoanime +- itsaturday +- Justdubs +- Kickassanime - Kissanimefree +- Kissanime - requires Selenium +- Kisscartoon - requires Selenium +- Nyaa.si +- RyuAnime +- twist.moe - requires Node.js +- Watchmovie +- Yify - Vostfree - Voiranime - Vidstream -- Animixplay -- Animepahe - requires Node.js -- twist.moe - requires Node.js -- Kissanime - requires Selenium -- Kisscartoon - requires Selenium -Sites That require Selenium **DO NOT** and **WILL NOT** work on mobile operating systems +Sites that require Selenium **DO NOT** and **WILL NOT** work on mobile operating systems -Twist.moe **DOES NOT** work and **WILL NOT** work on iOS, a Python Module that is required for twist.moe is not supported on iOS and cannot be installed +Twist.moe **DOES NOT** work and **WILL NOT** work on iOS, a specific Python module that is required for twist.moe is not supported on iOS and cannot be installed. ## Installation @@ -95,21 +96,21 @@ Twist.moe **DOES NOT** work and **WILL NOT** work on iOS, a Python Module that i If you have trouble installing, see extended installation instructions [here](https://anime-downlader.readthedocs.io/en/latest/usage/installation.html) or join the [discord server](https://discord.gg/Qn2nWGm) for help. **Note**: -- For cloudflare scraping either [cfscrape](https://github.com/Anorov/cloudflare-scrape) or [selenium](https://www.selenium.dev/) is used. [Cfscrape](https://github.com/Anorov/cloudflare-scrape) depends on [`node-js`](https://nodejs.org/en/) and [selenium](https://www.selenium.dev/) utilizes an automated invisible instance of a browser (chrome/firefox). So, if you want to use cloudflare enabled sites, make sure you have [node-js](https://nodejs.org/en/) and a [webdriver](https://www.selenium.dev/selenium/docs/api/py/index.html#drivers) installed. +- For Cloudflare scraping either [cfscrape](https://github.com/Anorov/cloudflare-scrape) or [selenium](https://www.selenium.dev/) is used. [Cfscrape](https://github.com/Anorov/cloudflare-scrape) depends on [`node-js`](https://nodejs.org/en/) and [selenium](https://www.selenium.dev/) utilizes an automated invisible instance of a browser (chrome/firefox). So, if you want to use Cloudflare enabled sites, make sure you have [node-js](https://nodejs.org/en/) and a [webdriver](https://www.selenium.dev/selenium/docs/api/py/index.html#drivers) installed. - You might have to use pip3 depending on your system ## Usage See [docs](https://anime-downlader.readthedocs.io/en/latest/usage/dl.html). -Anime downloader has two sub commands, `dl` and `watch`. +Anime Downloader has two sub-commands, `dl` and `watch`. - [dl](https://anime-downlader.readthedocs.io/en/latest/usage/dl.html): `dl` can download anime. - [watch](https://anime-downlader.readthedocs.io/en/latest/usage/watch.html): `watch` can manage your anime watch list. Needs [mpv](https://mpv.io). Deprecated in favour of [adl](https://github.com/RaitaroH/adl) **To use `anime_downloader` in your package:** -This tool can be used as a library. This means you can import it into your own application and search for anime and do many other wonderful things. +This tool can be used as a library. This means you can import it into your own applications and search for anime and do many other wonderful things. See [documentation](https://anime-downlader.readthedocs.io/en/latest/usage/api.html). **Development Instructions:** diff --git a/docs/advanced/custom_site.rst b/docs/advanced/custom_site.rst index f2d6c13..7f7a872 100644 --- a/docs/advanced/custom_site.rst +++ b/docs/advanced/custom_site.rst @@ -3,13 +3,13 @@ Writing your own custom site class :code:`anime_downloader` is built with easy extensibility in mind. -Each of the site (in the tool) can roughly be classfied into two. +Each of the sites (in the tool) can roughly be classfied into two catagories; -- Sites which don't use cloudflare DDoS protection. Ex: :py:class:`~anime_downloader.sites.nineanime.NineAnime` -- Sites which use cloudflare DDoS protection. Ex: :py:class:`~anime_downloader.sites.kissanime.KissAnime` +- Sites which don't use Cloudflare DDoS protection: Ex: :py:class:`~anime_downloader.sites.nineanime.NineAnime` +- Sites which use Cloudflare DDoS protection: Ex: :py:class:`~anime_downloader.sites.kissanime.KissAnime` All sites have the base class :py:class:`~anime_downloader.sites.anime.Anime`. -There are helper functions defined :py:func:`anime_downloader.sites.helpers.request.get` and :py:func:`anime_downloader.sites.helpers.request.post`. +There are helper functions defined by :py:func: `anime_downloader.sites.helpers.request.get` and :py:func:`anime_downloader.sites.helpers.request.post`. You are expected to use these functions to perform any network requests. There is also a helper function :py:func:`anime_downloader.sites.helpers.request.soupfiy` for making `BeautifulSoup` s out of requests. diff --git a/docs/advanced/testing.rst b/docs/advanced/testing.rst index a41ace8..c3f1dab 100644 --- a/docs/advanced/testing.rst +++ b/docs/advanced/testing.rst @@ -3,7 +3,7 @@ Testing We use pytest for testing. -You can run specific tests by specifying the file.:: +You can run specific tests by specifying the file; :: $ pytest tests/test_twistmoe.py @@ -23,7 +23,7 @@ To use it, run the tool using the new provider. In this doc, we will use the exa In the above output, we can see the temp directory created by the tool. Copy this temp directory to tests/test_sites and name it test_. -After this you are ready to write the tests. The twist.moe test file is given below for reference. +After this, you are ready to write the tests. The twist.moe test file is given below for reference. Remember to use the function :py:function:`configure_httpretty()` to configure the mock before making any requests. diff --git a/docs/index.rst b/docs/index.rst index e95e931..2bd1b80 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,10 +3,10 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to anime-downloader's documentation! +Welcome to Anime-Downloader's documentation! ============================================ -anime-downloader helps you download your favorite anime +Anime-Downloader helps you download your favorite anime Features -------- @@ -15,22 +15,34 @@ Features - Specify the quality you want to stream or download. - Search and download. - Save yourselves from those malicious ads. -- Add any anime to your watch list using `anime watch` and let anime downloader take care of everything for you. - Download using external downloader ([aria2](https://aria2.github.io/) recommended). - Configurable using `config.json`. See [doc](https://github.com/vn-ki/anime-downloader/wiki/Config). Supported Sites --------------- -- 9anime -- twist.moe -- KissAnime [cloudflare] -- Masterani.me [cloudlfare] -- KissCartoon [cloudflare] +- Animepahe +- Anistream +- Animeflix +- Animefreak - Gogoanime -- AnimePahe [cloudflare] +- Dubbedanime +- a2zanime +- animeout +- itsaturday +- Animeflv +- Kickassanime +- DreamAnime +- RyuAnime +- Erai-Raws +- Animesimple +- Animerush +- Watchmovie +- twist.moe - requires Node.js +- Kissanime - requires Node.js +- Kisscartoon - requires Node.js -NOTE: To download from sites marked `[cloudflare]`, anime-downloader has to be installed with cloudflare support(See below). +NOTE: To download from sites marked `[cloudflare]`, anime-downloader has to be installed with cloudflare support(See below); .. toctree:: :maxdepth: 2 diff --git a/docs/usage/api.rst b/docs/usage/api.rst index 5f9e556..38b180a 100644 --- a/docs/usage/api.rst +++ b/docs/usage/api.rst @@ -1,10 +1,10 @@ Library usage ============= -Anime downloader can be used as a library too. +Anime Downloader also be used as a library. -The following code searches for 'one punch' from twist.moe +The following code searches for 'one punch' from twist.moe; :py:func:`~anime_downloader.sites.init.get_anime_class` can be used to import specific sites using the url one of :py:data:`~anime_downloader.commands.dl.sitenames`. @@ -26,5 +26,5 @@ The following code searches for 'one punch' from twist.moe print(anime[0].source().stream_url) -In the above example `TwistMoe` is a concrete implementation of :py:class:`anime_downloader.sites.anime.Anime`. -Search results is list of :py:class:`anime_downloader.sites.anime.SearchResult`. +In the above example, `TwistMoe` is a concrete implementation of :py:class:`anime_downloader.sites.anime.Anime`. +Search results is a list of :py:class:`anime_downloader.sites.anime.SearchResult`. diff --git a/docs/usage/config.rst b/docs/usage/config.rst index c67ead5..d27d2c5 100644 --- a/docs/usage/config.rst +++ b/docs/usage/config.rst @@ -9,9 +9,9 @@ This can be found under: - ``C:\Users\[Username]\AppData\Roaming\anime downloader`` on Windows -- ``~/Library/Application Support/anime downloader`` on macos +- ``~/Library/Application Support/anime downloader`` on MacOS -You can override the settings in the ``config.json``, with command line +You can override the settings in the ``config.json`` with the following command line arguments. The default config file is given below. @@ -153,7 +153,7 @@ Choosing preferred server ######## ``server`` contains the preferred server. -``servers`` contains a list of servers, used in order. Set preferred server by changing the order of the list. +``servers`` contains a list of servers, used in order. Set the preferred server by changing the order of the list. ``fallback_servers`` contains a list of servers to use if the primary server is not found, used in order. diff --git a/docs/usage/dl.rst b/docs/usage/dl.rst index 0089022..7fb84e8 100644 --- a/docs/usage/dl.rst +++ b/docs/usage/dl.rst @@ -10,7 +10,7 @@ Search and download ^^^^^^^^^^^^^^^^^^^ -- To search and download all episodes. +- To search and download all episodes use the following command; .. code:: bash @@ -22,38 +22,39 @@ To search on kissanime, anime dl 'code geass' --provider animepahe -Run ``anime dl --help`` for help text on ``dl`` subcommand. +Run ``anime dl --help`` for help using the ``dl`` subcommand. Download directly ^^^^^^^^^^^^^^^^^ -- To download Fullmetal Alchemist: Brotherhood all episodes +- To download Fullmetal Alchemist: Brotherhood all episodes; :: anime dl 'https://animepahe.com/anime/fullmetal-alchemist-brotherhood' -- To download Fullmetal Alchemist: Brotherhood episode 1 +- To download Fullmetal Alchemist: Brotherhood episode 1; :: anime dl 'https://animepahe.com/anime/fullmetal-alchemist-brotherhood' --episodes 1 -- To download Fullmetal Alchemist: Brotherhood episode 1 to 20 +- To download Fullmetal Alchemist: Brotherhood episode 1 to 20; :: anime dl 'https://animepahe.com/anime/fullmetal-alchemist-brotherhood' --episodes 1:21 -- To get stream url of Fullmetal Alchemist: Brotherhood episode 1. +- To get stream url of Fullmetal Alchemist: Brotherhood episode 1; :: anime dl 'https://animepahe.com/anime/fullmetal-alchemist-brotherhood' --url --episodes 1 -- To play using vlc. (On windows use path to exe) +- To play using vlc. (On windows use path to exe); :: anime dl 'https://animepahe.com/anime/fullmetal-alchemist-brotherhood' --play vlc --episodes 1 + diff --git a/docs/usage/installation.rst b/docs/usage/installation.rst index 90dada5..a58b0fa 100644 --- a/docs/usage/installation.rst +++ b/docs/usage/installation.rst @@ -1,11 +1,7 @@ Installation ------------ - -The following are extended installation instructions for Windows and -Linux users. (For windows choco users, scroll to last) - -Installation Instructions for *Mobile operating systems* are at the bottom, the 2 OS's explained are Android and iOS +This document provides complete installation instructions for the following systems: Windows, Mac, Linux, Android, iOS and Windows Choco. Please contact the dev team if you find any errors or inconsistencies in this document. Windows ~~~~~~~ @@ -15,7 +11,7 @@ Please see this video: https://www.youtube.com/watch?v=gC2tctOL5I8 Automatic Windows install ~~~~~~~~~~~~~~~~~~~~~ -Add the following to a file named install.bat and then run it as administrator. +Add the following to a file named install.bat and then run it as Administrator; .. code:: @@ -29,48 +25,45 @@ Add the following to a file named install.bat and then run it as administrator. Windows via ``choco`` ~~~~~~~~~~~~~~~~~~~~~ - Contributed by @CodaTheOtaku - -.. note:: - make sure you are running the Command Prompt in "Run as Adminstrator" mode + Contributed by @CodaTheOtaku +**NOTE** Ensure the Command Prompt (cmd) is being ran as Administrator. - Install `Chocolatey`_ Package manager. -- Using the Chocolatey Package Manager:: +- Using the Chocolatey Package Manager; :: choco install -y git mpv python3 aria2 nodejs -- Once these are installed:: +- Once these are installed; :: pip3 install -U git+https://github.com/vn-ki/anime-downloader.git -- then the commands to view a show would be:: +- Then, the commands to view a show would be; :: - anime watch --provider *Insert provider name* --new + anime dl "showname" --provider *Insert provider name* --new --play *mpv or vlc* Mac ~~~ -Anime downloader is avaible from brew.:: +Anime-Downloader is available from brew via the following command; :: brew install anime-downloader Linux ~~~~~ -If you are using linux, you most probably already have python installed. - -Type ``pip --version`` into your terminal. If it says python2, replace +If you are using Linux, Python is probably already installed. +Type ``pip --version`` into your terminal. If the command returns python2, replace all the following ``pip`` with ``pip3``. - Install aria2. -- Install anime-downloader :: +- Install Anime-Downloader via the following command; :: pip3 install anime-downloader -- To install master branch:: +- To install the bleeding-edge version of Anime-Downloader use this alternative command;: pip3 install -U git+https://github.com/vn-ki/anime-downloader.git - Enjoy. @@ -87,76 +80,73 @@ all the following ``pip`` with ``pip3``. Android ~~~~~~~ -This does not require a rooted device to work +This does not require a rooted device to work. -- Install Termux or similar Terminal Emulator +- Install Termux or similar Terminal Emulator. -- Install Aria2c via the following command if using Termux :: +- Install Aria2c via the following command if using Termux; :: pkg install aria2c -- Install Python via the following command if using Termux :: +- Install Python via the following command if using Termux; :: pkg install python -- Install git via the following command if using Termux :: +- Install git via the following command if using Termux; :: pkg install git -- Install Anime-Downloader via the following command after python and git are installed :: +- Install Anime-Downloader via the following command after python and git are installed; :: pip3 install -U git+https://github.com/vn-ki/anime-downloader.git -- Enjoy, The normal commands should work the same as on the computer +- The usage commands should now match the commands used on PC. iOS (Jailbreak Required) ~~~~~~~~~~~~~~~~~~~~~~~~ -If you want this project to work on an iOS Device, you will need a jailbroken iPhone. visit r/jailbreak on reddit for the latest jailbreak news and information. + A jailbroken iPhone is required. Visit r/jailbreak on Reddit for the latest jailbreak news and information. -If you already happen to be jailbroken, then great! you are all set to go! +Tinkering May be Required. -Tinkering May be Required +- Install the following packages from the mcapollo repo (https://mcapollo.github.io/Public/) using your favorite package manager; :: -- Install the following packages from the mcapollo repo (https://mcapollo.github.io/Public/) using your favorite package manager :: - - Aria2, Python@3.7, git, nano (for File editing), A Terminal Emulator (I recommend NewTerm because it has navigation keys) + Aria2, Python@3.7, git, nano (for File editing) and a Terminal Emulator (NewTerm is an example of this). -- Open your Terminal Emulator and type in the following command :: +- Open your Terminal Emulator and type in the following command; :: python3 -m ensurepip -- That should set up pip and setuptools +- Pip and setuptools should now be installed. +The following steps install Anime-Downloader; +- To install Anime-Downloader before the PR which moves an unsupported module into extras follow along, if not, skip to **(continue)**; -- Next you want to install Anime-Downloader -- To Install Anime-Downloader before the PR which moves an unsupported module into extras follow along, if not, skip to where it has continue in parentheses - -- First you want to clone the repository via this command :: +- Firstly, clone the repository via this command; :: git clone https://github.com/vn-ki/anime-downloader.git -- next you want change your directory into the cloned repo. To do so, use the following command (it is case sensitive) :: +- Next, change your directory into the cloned repo. To do so, use the following case-sensitive command; :: cd anime-downloader -- next you want to type in this command to start editing the file :: +- Following this, type in the following command to start editing the file; :: nano setup.py -- use the arrow keys to navigate to the line that says :: +- Navigate to the following line using the arrow keys; :: 'pycryptodome>=3.8.2', -- And Delete that line so it looks like this +- Delete the highlighted line as to match the image below; -::image: https://i.imgur.com/0fRiNP6.png +:image: https://i.imgur.com/0fRiNP6.png -- press the ctrl button then the letter "o", press enter, then press the ctrl button again, then press the letter "X" +- Press ctrl+o then enter then press ctrl+X. -- it should exit you back to the command line +- If all the steps were performed correctly then you should be back to the command line. -- **(continue)** type the following command to install the project :: +- **(continue)** Type the following command to install the project; :: python3 setup.py install -- let it run through, then the program should work as it does on the computer +- Wait for the line to finish, then the program functions the same as the PC version. diff --git a/docs/usage/sites.rst b/docs/usage/sites.rst index 47410b7..5fc983c 100644 --- a/docs/usage/sites.rst +++ b/docs/usage/sites.rst @@ -1,7 +1,7 @@ Site Configs ------------ -The following are the sites with configs. These can be configured using the config file. The keys and corresponding possible values are mentioned below. +The following are the sites with configs. These can be configured using the config file. The keys and corresponding possible values are mentioned below; .. autoclass:: anime_downloader.sites.animeflv.Animeflv .. autoclass:: anime_downloader.sites.anistream.Anistream diff --git a/docs/usage/watch.rst b/docs/usage/watch.rst index f2bd772..e1d73f4 100644 --- a/docs/usage/watch.rst +++ b/docs/usage/watch.rst @@ -1,4 +1,4 @@ -``watch`` +``watch - DEPRECIATED`` ========= .. note:: You need `mpv`_ to use this subcommand.