anime-downloader/docs/advanced/custom_site.rst

Writing your own custom site class
**********************************

:code:`anime_downloader` is built with easy extensibility in mind.

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`

All sites have the base class :py:class:`~anime_downloader.sites.anime.Anime`.
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.

All requests are cached. So don't worry about making requests twice.
add docs 2018-10-09 08:04:27 -07:00			`Writing your own custom site class`
			`**********************************`

more docs 2018-10-15 10:10:35 -07:00			:code:`anime_downloader` is built with easy extensibility in mind.

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 2020-07-20 15:04:47 -07:00			`Each of the sites (in the tool) can roughly be classfied into two catagories;`
more docs 2018-10-15 10:10:35 -07:00
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 2020-07-20 15:04:47 -07:00			- 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`
more docs 2018-10-15 10:10:35 -07:00
docs: some more docs 2019-03-22 07:27:26 -07:00			All sites have the base class :py:class:`~anime_downloader.sites.anime.Anime`.
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 2020-07-20 15:04:47 -07:00			There are helper functions defined by :py:func: `anime_downloader.sites.helpers.request.get` and :py:func:`anime_downloader.sites.helpers.request.post`.
docs: some more docs 2019-03-22 07:27:26 -07:00			`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.

			`All requests are cached. So don't worry about making requests twice.`