Each provider consists of a definition in definitions.json file in /burst/providers/ folder and an icon in /burst/providers/icons/ folder.
Icon is optional, but very much desired. It is easier to quickly find relevant search result, when you visually differ providers.
If you want to try adding new provider, the workflow is about that:
git clone git@github.com:yourusername/script.elementum.burst.gitgit checkout -b my_providergit push origin my_providerPlease, try not to make changes in the Python code of Burst.
If you feel you have no other option - run
flake8before you commit.
It will do basic syntax and code checks. Should run without errors.
Definitions are a JSON list of a smaller parts, each of them describes separate providers. There are no inherited settings, or default settings, each provider’s setting should be explicitly setted.
Example of provider definition:
"ilcorsaroblu": {
"enabled": true,
"predefined": false,
"private": false,
"name": "Il Corsaro Blu",
"languages": "it",
"anime_extra": "",
"anime_keywords": "{title:original} {episode}",
"anime_query": "",
"base_url": "https://www.ilcorsaroblu.org/index.php?page=torrents&search=QUERYEXTRA&x=0&y=0",
"color": "FFFFFFFF",
"general_extra": "",
"general_keywords": "{title:original}",
"general_query": "0",
"language": null,
"login_failed": "",
"login_object": "",
"login_path": null,
"movie_extra": "",
"movie_keywords": "{title:original} {year}",
"movie_query": "",
"parser": {
"row": "find_once(tag='table', select=('class', 'lista'), order=4).find_all('tr')",
"name": "item(tag='td', order=2)",
"seeds": "item(tag='td', order=7)",
"peers": "item(tag='td', order=6)",
"size": "item(tag='td', order=9)",
"torrent": "'https://www.ilcorsaroblu.org/%s' % item(tag='a', attribute='href', order=3)"
},
"season_extra": "",
"season_extra2": "",
"season_keywords": "{title:original} Season_{season}",
"season_keywords2": "{title:original} Season{season}",
"season_query": "",
"separator": "%20",
"show_query": "",
"subpage": true,
"tv_extra": "",
"tv_extra2": "",
"tv_keywords": "{title:original} s{season:2}e{episode:2}",
"tv_keywords2": "{title:original} s{season:2}"
}
This part is very important:
"enabled": true,
"predefined": false,
"private": false,
"name": "Il Corsaro Blu",
"languages": "it",
Where columns mean:
enabled: boolean, defines if provider is available (not selected to search, but available for selection).predefined: boolean, defines if provider is enabled by default upon installation of Burst (default providers).private: boolean, defines if provider is private, so login should be executed.name: string, name of provider, no special characters, name will be shown in Kodi settings and search results.languages: string, languages used on the tracker, 2-char codes list of languages (like it, fr, en, es), can be ommited.anime_extra: string, text, later replaced into EXTRA keyword in search url.anime_keywords: string, query for anime searches.anime_query: string, part of url, added to base_url.base_url: string, URL, used for further uses in searches.color: string, Kodi color code. Can be substituted with word representation. See: https://s3.amazonaws.com/f.cl.ly/items/1A3S2n0l103n460Y1I0e/chart.jpg .
general_extra: string, text, later replaced into EXTRA keyword in search url.general_keywords: string, query for general searches (when you type the query).general_query: string, part of url, added to base_url.language: string, 2-char language definition, which language is used to searches.login_failed: string, text to search, to identify we failed with loggin (or better a unique text that indicates we are not logged in).login_object: string, object to use for logging in. USERNAME and PASSWORD are substituted.login_path: string, url, used to POST login object to.movie_extra: string, text, later replaced into EXTRA keyword in search url.movie_keywords: string, query for movie searches.movie_query: string, part of url, added to base_url.parser: array, defines how to parse result page.
row: query searches for rows, each of them will be parsed for torrent information.name: query for torrent name.seeds: query for seeds count.peers: query for peers count.size: query for torrent size.torrent: query for torrent file link or magnet link.season_extra: string, text, later replaced into EXTRA keyword in search url.season_extra2: string, text, later replaced into EXTRA keyword in search url.season_keywords: string, query for season searches.season_keywords2: string, query for season searches.season_query: string, part of url, added to base_url.separator: string, chars, used to separate words in the query (like %20 or -).show_query: string, string that is added to the base_url for episodes searches.subpage: boolean, defines if provider needs a separate request to get parser->torrent link and find magnet/torrent there.tv_extra: string, text, later replaced into EXTRA keyword in search url.tv_extra2: string, text, later replaced into EXTRA keyword in search url.tv_keywords: string, query for episode searches.tv_keywords2: string, query for episode searches.Icon requirements are pretty easy:
Place it with provider_id.png file name and it will be used everywhere.
Our parser is ehp.py, it’s not an XPath parser, but it gives you fine speed and is pretty fault-tolerant to broken html code.
Project code: https://github.com/iogf/ehp
You can see examples in existing definitions. Basically you will need:
find_once if you need to fine one item;find_all if you need a list of results (like rows);item if you need something specific (like name or specific link).Kodi Locations can be discovered here: https://kodi.wiki/view/Log_file/Advanced#Location
You can copy your cloned git repository into Kodi path and just run search from Kodi, it will use the new code without need to restart Kodi. So you can easily run and track results.
In Linux it’s something like:
cp -rf /path/to/your/repo/* ~/.kodi/addons/script.elementum.burst/
Then, if you also want to debug the parser, you can enable excessive debugging:
Burst Kodi settings -> Advanced -> Log debug messages for parsing
You will see what parser rule we run, and what we match.
Added provider is not enabled for searching by default, you have to enable it in Kodi settings.
So you can run ./scripts/generate_settings.py to regenerate settings.xml file, then copy it to Kodi and restart Kodi (settings.xml are read on load or addon installation only).
Only custom providers (not provided with Burst) are enabled by default and you cannon enable or disable them.