xbmc/generator-kodi-addon

Yeoman generator for the most common Kodi addon types.

generator-kodi-addon

Creates the basic structure for a kodi script, written in python.

Installation

First, install Yeoman and generator-kodi-addon using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-kodi-addon

Then generate your new project:

yo kodi-addon

Development

• Check out this project via git
• Browse to the folder via commandline
• Do npm link
• Now you can use yo kodi-addon, which should include your changes.

License

Apache-2.0 © Kolja Lampe

generator-kodi-addon's Issues

Prepare next release

I would like to release the next version, so what should we do before that?
Something we want to add before hand?

• More tests

Create a commons module

Create a commons module offering logging and some common functions out of the box.
So that other addons can depend on it and we can use it for the generator.

PVR addon

why can't tthis generate the skeleton for PVR addons ?

feedback for Kodi target version

? Choose the minimal Kodi Version your targeting.
  Krypton
❯ Jarvis

• Add a version number - I forgot what versions Krypton and Jarvis were (which is newer, etc)
• Also let us enter in a number because I'm trying to target 19 because of python3

Delete gulp-util

Yo can replace with;

gutil.File => https://www.npmjs.com/package/vinyl
gutil.replaceExtension => The .extname property on Vinyl objects or https://www.npmjs.com/package/replace-ext
gutil.colors => https://www.npmjs.com/package/ansi-colors
gutil.date => https://www.npmjs.com/package/date-format
gutil.log => https://www.npmjs.com/package/fancy-log
gutil.template => https://www.npmjs.com/package/lodash.template
gutil.env => https://www.npmjs.com/package/minimist
gutil.beep => https://www.npmjs.com/package/beeper
gutil.noop => https://www.npmjs.com/package/through2
gutil.isStream => Use the .isStream() method on Vinyl objects
gutil.isBuffer => Use the .isBuffer() method on Vinyl objects
gutil.isNull => Use the .isNull() method on Vinyl objects
gutil.linefeed => Use the string '\n' in your code
gutil.combine => https://www.npmjs.com/package/multipipe
gutil.buffer => https://www.npmjs.com/package/list-stream
gutil.PluginError => https://www.npmjs.com/package/plugin-error

Source: https://medium.com/gulpjs/gulp-util-ca3b1f9f9ac5

Specific Readmes per addons type

Error 1st Run Newbee

Hi on first run folder created then the following. I am running as admin Win 10
*** Please tell me who you are.
Run
git config - - user. email "[email protected]"
git config - - user. name "Your Name"
to set your account's default identity.
omitt - - global to set the identity only in this reposiry.
fatal: unable to auto-detect email address (got 'Frederick@freds_pc.(none)')
Can you help please want to open a Web page on Kodi android.
Thanks
Fred
Ps where are files saved

Make sure generator follows repo rules

iirc we changed something in the addon.xml layout to be more strict. Best is to check if this follows those rules.

Html characters in addon title

As mentioned on slack:

The kodi-addon-generator uses html characters instead of the ascii equivalent for some characters. Maybe it can be avoided when generating the templates? I tried the original version of this addon in Kodi without any issue and across ~ 3 skins. However something tells me this can be an issue at some point.

see: xbmc/repo-plugins#1878 (diff)

Integrate and automatically install kodi-stubs

https://github.com/romanvm/Kodistubs should be pulled from pip by default
And can we somehow set them up by default?

@romanvm

Boilerplate for common code

We should embed some common code like translation handling.

Any more ideas what might be nice to have?

Add provides game

Script can have this it seems

game

Does this only apply to scripts and should we add it?

Discussion try/except code smell?

As raised in #6 (review)

Phil said this code smells as if something is done wrongly.

            try:
                xbmc.log(self.format(record), levels[record.levelno])
            except UnicodeEncodeError:
                xbmc.log(self.format(record).encode('utf-8', 'ignore'), levels[record.levelno])

Ronie said

perhaps this post may be useful to you:
http://forum.kodi.tv/showthread.php?tid=144677
it explains how to properly handle/avoid unicode errors.
there's an example log function at the bottom of the post, which i've been using in all my addons for years now, and never had an issue with it.

Let's talk about it, as I feel the try/except is way more pythonic then the one solution named in the forum

Convention for "kodi" classes

Just something to discuss:

What I'm doing with trakt is, splitting methods between two files, for e.g.:

• kodiUtilities.py is everything I would have in a utilities class, that binds to one of the xbmc/kodi imports
• utilities.py gets every method that doesn't have a dependency to one of these

So now I can write unit tests for utilities.py, pretty easily.
Here the question, is this a good practice? Is this a practice we want to push?

@phil65 @MartijnKaijser @enen92 @BigNoid @phate89

Ask if the user wants the settings file

We should ask, if the user wants a settings.xml for the addon types that support those.

Specific boilerplate examples for each project type

Use same python code style in every template

Currently there's still differences between the templates and they should be matched up as much as possible

Please add a LICENSE file

Please add a LICENSE file to the repository to understand what kind of license applies to the code.

Add a travis config file that builds the tests

• Add travis config file
• Add instructions how to enable travis to build from your repo

The .py file referenced from Addon.xml should be as minimal as possible

To get best speed the default python file should be bare minimal and then call the main file from that. Reason is the main referenced one isn't kept compiled while the others are kept compiled

Align license questions

We're currently asking twice for which license you want to use, due to us needing this info for the addons.xml and to generate the license.md.

We can hopefully boil this down, if this ever gets solved:
jozefizso/generator-license#37