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.

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.12.tar.gz (20.2 kB view details)

Uploaded Source

Built Distribution

kodi_addon_checker-0.0.12-py3-none-any.whl (50.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kodi-addon-checker-0.0.12.tar.gz
  • Upload date:
  • Size: 20.2 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.12.tar.gz
Algorithm Hash digest
SHA256 efb4473aaf84ce0b4456447d93e0282a46ebe88f8eb53f9a5ff3eb8b24d8605e
MD5 65c57d67acd59bdbdf25f7217f7f5418
BLAKE2b-256 f5fdc722953daf67be434574411794f811f74b440821c88a56cad3f87cce8462

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kodi_addon_checker-0.0.12-py3-none-any.whl
  • Upload date:
  • Size: 50.7 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.12-py3-none-any.whl
Algorithm Hash digest
SHA256 c219778e84941d0bcb29d31be8a921a468ef6648b95b894f2e73c1a8b24a4705
MD5 68c877566a28f3802327798f260462ff
BLAKE2b-256 bc5a0e53a661ff998e4fa8b361fb3c00ab1e64dd83c4af1b459475c5bf53e7b4

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