Skip to main content

Check kodi addons or whole kodi repositories for errors and best practices.

Project description

Build Status PyPI version

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 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

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
  • 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kodi-addon-checker-0.0.13.tar.gz (21.8 kB view details)

Uploaded Source

Built Distribution

kodi_addon_checker-0.0.13-py3-none-any.whl (54.3 kB view details)

Uploaded Python 3

File details

Details for the file kodi-addon-checker-0.0.13.tar.gz.

File metadata

  • Download URL: kodi-addon-checker-0.0.13.tar.gz
  • Upload date:
  • Size: 21.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.15

File hashes

Hashes for kodi-addon-checker-0.0.13.tar.gz
Algorithm Hash digest
SHA256 d01b3b0ded83d92c3e78507ec79c5adca93538457114d52eb5963ec63dc0ea02
MD5 b7002022351ea59c9bc2a9ef2ed8a198
BLAKE2b-256 ff26e867863842a4cf54ba3de1fdbcf6b3a5e6109c78860759db3b6f84beeb00

See more details on using hashes here.

File details

Details for the file kodi_addon_checker-0.0.13-py3-none-any.whl.

File metadata

  • Download URL: kodi_addon_checker-0.0.13-py3-none-any.whl
  • Upload date:
  • Size: 54.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.15

File hashes

Hashes for kodi_addon_checker-0.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 0f15761076c7420fa413a6c45a955b03fdc0424f0d593ffad614ad15156e7f7c
MD5 01b8a05186679c24753af6b5c69e68d0
BLAKE2b-256 37e864826cf1eb7aad8f9dbb16f290419073cf9663dfadedf69e1d90f62a8669

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page