Skip to main content

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

Project description

Build and test addon-checker 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 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 Development

  • 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
--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
--skip-dependency-checks    do not check if addon dependencies are available in the official Kodi addon repository

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

Uploaded Source

Built Distribution

kodi_addon_checker-0.0.36-py3-none-any.whl (73.7 kB view details)

Uploaded Python 3

File details

Details for the file kodi_addon_checker-0.0.36.tar.gz.

File metadata

  • Download URL: kodi_addon_checker-0.0.36.tar.gz
  • Upload date:
  • Size: 47.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for kodi_addon_checker-0.0.36.tar.gz
Algorithm Hash digest
SHA256 67b61dcca224c6573c5e4423245cdaf4a22d74aa1f2d8b9a7ebbedac2e982d60
MD5 ecd9ae9a066c440d480b953238069d35
BLAKE2b-256 8e6ee56df6f993d29e927f967846eec18db23e125373baae4924bd80bcad8cae

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for kodi_addon_checker-0.0.36-py3-none-any.whl
Algorithm Hash digest
SHA256 bb524725f145bab9cd46ac59b10ca136717ef0c664b00f1d50fc296f431f9e8b
MD5 87c92884b941626bbf56532ca5bd4188
BLAKE2b-256 51d4e340b5ea12254b29d9ce0623cdbb0a8184cc48442a235910112220e11970

See more details on using hashes here.

Supported by

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