Check kodi addons or whole kodi repositories for errors and best practices.
Project description
Kodi Addon checker
This tool checks the Kodi repo for best practices and produces a report containing found problems and warnings.
It can also be used locally for detecting problems in your addons.
Features
-
Checks if artwork is available and if the size is as defined
-
Checks if all artworks(images/fanart/screenshot) are valid.
-
Checks if addon.xml and license file exists for an addon.
-
Checks if all xml files are valid.
-
Check if all the json files are valid.
-
Checks if the addon id in addon.xml matches with the folder name.
-
Checks if the addon uses the old strings.xml translation format.
-
Check if the addon uses the old language folders (English vs resource.language.en_gb).
-
Checks for various blacklisted strings.
-
Check for blacklisted filetypes.
-
Check for new dependencies present in addon.xml files.
-
Check the complexity of the entrypoint files for addon.
-
Check if addon already exists in any of lower repositories
-
Check if addon already exists in any of the upper repositories (with non-compatible python abi) with a lower version, thus preventing a user kodi migration
-
Check if addon is compatible with python3 or not
-
Check specific version attribute
-
Validate addon.xml against schemas
-
Check if files in addon are marked as executable or not.
-
Check for unused script.module addons
-
Check presence of extensions in addon dependencies.
-
Check for valid forum, source and website value in addon.xml
-
Check if all PO files are valid
All of the validation and checks are done according to the kodi addon rules
Installation
- You will need Python3.
Then you can directly install it from pip package:
pip install kodi-addon-checker
For Developement
- Clone the repository
git clone https://github.com/xbmc/addon-check
cd <path-to-cloned-repo>
- Install the requirements:
pip install -r requirements.txt
Usage
-
If you are in add-on directory:
- Execute
kodi-addon-checker
- Execute
-
If you want to run it from any other directory
- Execute
kodi-addon-checker <path-to-addon>
You can use the tool with the following options:
--version version of the tool
--branch name of the branch the tool is to run on
--PR only when the tool is running on a pull request
--allow-folder-id-mismatch allow the addon's folder name and id to mismatch
--reporter enable a reporter, this option can be used multiple times
--enable-debug-log enable debug logging to kodi-addon-checker.log
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for kodi-addon-checker-0.0.19.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cda2ef8b28b12b76388228635b50b440e3b252575aa0906425b80d5f2df765ea |
|
MD5 | a3f29a232dc35b2f8ece8992fd281b6d |
|
BLAKE2b-256 | 4567fb88af5043378fed5f02d11be83d55a8e86076f19efb0e4d2899b37359da |
Hashes for kodi_addon_checker-0.0.19-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 98836395412d0e4090f5a53a2a672cf3b2c28143041bc4c370e8b1b8b835e427 |
|
MD5 | f5d67b5bd8eee7a27006553805c6daab |
|
BLAKE2b-256 | 1c8b8b720d80cee28f1a22a3a852b2b54694e6c19d4150a0462e315ec9bbf87f |