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 the version in addon.xml is valid (for repository generator)
-
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.28.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8203bc3c59b22c9975669ed8f13f1458c644897500e6566acb2bda991a3d8871 |
|
MD5 | 2c6953141f39eb1a95b67ac7aadf172e |
|
BLAKE2b-256 | 7231c12255048ec9f13870de77cf90bb6b92ba365acc45080fb125ee5e0cd3c7 |
Hashes for kodi_addon_checker-0.0.28-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 646e0e7e67ae5c7fe0347a60427d3f15fd45f8d078ef0deba68431fc7316d7c4 |
|
MD5 | fb85dcc1ff1729ef36e718fda0cc3817 |
|
BLAKE2b-256 | 62bfb3ed4db9da9d94ad23dccbdecbee95d2920739816e9517ed5b2224adcd68 |