Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
willforde committed Mar 2, 2018
1 parent 02612c8 commit 08424df
Showing 1 changed file with 35 additions and 4 deletions.
39 changes: 35 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,46 @@
.. image:: https://api.codacy.com/project/badge/Grade/169396ed505642e9a21e9a4926d31277
:target: https://www.codacy.com/app/willforde/script.module.codequick?utm_source=github.com&utm_medium=referral&utm_content=willforde/script.module.codequick&utm_campaign=Badge_Grade


============
Introduction
============
Codequick is a framework for kodi add-on's. The goal of this framework is to simplify add-on development.
This is achieved by reducing the amount of boilerplate code to a minimum, automating as many tasks that can be
automated, like route dispatching and sort method selection. Ultimately allowing the developer to focus primarily
on scraping content from websites and passing it to kodi.
Codequick is a framework for kodi add-on's. The goal for this framework is to simplify add-on development.
This is achieved by reducing the amount of boilerplate code to a minimum while automating as many tasks that can be
automated. Ultimately allowing the developer to focus primarily on scraping content from websites and passing it to kodi.

* Route dispatching (callbacks)
* Callback arguments can be any python object that can be pickled
* Delayed execution (execute code after callbacks have returned results)
* No need to set 'isplayable/isfolder' properties
* Supports both python2 and python3
* Auto sort method selection
* Better error reporting
* Full unicode support
* Sets mediatype to 'video/music' depending on listitem type if not set
* Sets xbmcplugin.setContent base off mediatype infolabel.
* Sets xbmcplugin.setPluginCategory to the title of current folder
* Sets thumbnail to add-on icon image if not set
* Sets fanart to add-on fanart image if not set
* Sets icon to 'DefaultFolder.png/DefaultVideo.png' if not set
* Sets Plot to the listitem title if not set
* Auto type convertion for (str, unicode, int, float, long) infolables and stream info
* Support for media flags e.g. High definition '720p', audio channels '2.0'
* Reimplementation of listitem class that makes heavy use of dictionaries
* Builtin support for saved searches
* Youtube.dl intergration (https://forum.kodi.tv/showthread.php?tid=200877)
* Youtube intergration


Documentation
-------------
Documentation can be found over at ReadTheDocs.
http://scriptmodulecodequick.readthedocs.io/en/latest


Links
-----
* https://github.com/willforde/plugin.video.watchmojo
* https://github.com/willforde/plugin.video.earthtouch
* https://github.com/willforde/plugin.video.metalvideo
* https://github.com/willforde/plugin.video.science.friday

0 comments on commit 08424df

Please sign in to comment.