Archive:Create a repository for add-ons - Revision history

Karellen at 21:06, 12 July 2020

2020-07-12T21:06:55Z

← Older revision		Revision as of 21:06, 12 July 2020
Line 1:		Line 1:
	~~{{mininav\|[[Development]]\|[[Add-on development]]\|[[Add-on repositories]]}}~~

	{{outdated}}		{{outdated}}

Line 81:		Line 79:
	[https://youtu.be/2OPjwdbBSkw Video's Description.]		[https://youtu.be/2OPjwdbBSkw Video's Description.]

	~~==See also==~~
	* [[Unofficial_add-on_repositories]]
	~~'''Development:'''~~
	* [[Add-on development]]
	* [[Add-on repositories]]

	[[Category:~~Add~~-~~on development]]~~
	~~[[Category:Skin development]]~~		[[Category:Development-Archived]]
	~~[[Category:Repositories~~]]

Karellen: Karellen moved page HOW-TO:Create a repository for add-ons to Archive:Create a repository for add-ons without leaving a redirect: Outdated

2020-07-12T21:05:52Z

Karellen moved page HOW-TO:Create a repository for add-ons to Archive:Create a repository for add-ons without leaving a redirect: Outdated

← Older revision	Revision as of 21:05, 12 July 2020
(No difference)

Karellen at 06:42, 11 July 2020

2020-07-11T06:42:12Z

← Older revision		Revision as of 06:42, 11 July 2020
Line 40:		Line 40:

	== Repository Files ==		== Repository Files ==
	Repositories are distributed just like any other add-on. In order for you to browse one in XBMC, you'll need to [[Add-~~ons_for_XBMC_(Developement)~~\|create an add-on]] and install it. The repository addon extends the xbmc.addon.repository extension point, so in addition to the general XML structure and icons required for an icon, you'll need an <extension> block specfically pointing to your repository.		Repositories are distributed just like any other add-on. In order for you to browse one in XBMC, you'll need to [[Add-on_repositories\|create an add-on]] and install it. The repository addon extends the xbmc.addon.repository extension point, so in addition to the general XML structure and icons required for an icon, you'll need an <extension> block specfically pointing to your repository.
	Use the addon.xml of any of the [[Unofficial_add-on_repositories]] as a template.		Use the addon.xml of any of the [[Unofficial_add-on_repositories]] as a template.
	Online repositories should always have zip set to true, both for efficiency of download and for the protection that .zip offers by way of verifying the download (i.e. can we unzip it).		Online repositories should always have zip set to true, both for efficiency of download and for the protection that .zip offers by way of verifying the download (i.e. can we unzip it).

Karellen at 06:41, 11 July 2020

2020-07-11T06:41:02Z

← Older revision		Revision as of 06:41, 11 July 2020
Line 5:		Line 5:
	See [[Add-on_repositories]] for up-to-date reference documentation.		See [[Add-on_repositories]] for up-to-date reference documentation.

	When you have created your repository, feel free to add it to the [[~~3rd party add~~-~~on repositories~~]] list.		When you have created your repository, feel free to add it to the [[Unofficial_add-on_repositories]] list.

	== Things you will require ==		== Things you will require ==
Line 41:		Line 41:
	== Repository Files ==		== Repository Files ==
	Repositories are distributed just like any other add-on. In order for you to browse one in XBMC, you'll need to [[Add-ons_for_XBMC_(Developement)\|create an add-on]] and install it. The repository addon extends the xbmc.addon.repository extension point, so in addition to the general XML structure and icons required for an icon, you'll need an <extension> block specfically pointing to your repository.		Repositories are distributed just like any other add-on. In order for you to browse one in XBMC, you'll need to [[Add-ons_for_XBMC_(Developement)\|create an add-on]] and install it. The repository addon extends the xbmc.addon.repository extension point, so in addition to the general XML structure and icons required for an icon, you'll need an <extension> block specfically pointing to your repository.
	Use the addon.xml of any of the [[~~3rd party add~~-~~on repositories~~]] as a template.		Use the addon.xml of any of the [[Unofficial_add-on_repositories]] as a template.
	Online repositories should always have zip set to true, both for efficiency of download and for the protection that .zip offers by way of verifying the download (i.e. can we unzip it).		Online repositories should always have zip set to true, both for efficiency of download and for the protection that .zip offers by way of verifying the download (i.e. can we unzip it).

Line 82:		Line 82:

	==See also==		==See also==
	* [[~~3rd party add~~-~~on repositories~~]]		* [[Unofficial_add-on_repositories]]
	'''Development:'''		'''Development:'''
	* [[Add-on development]]		* [[Add-on development]]

Takoi at 09:52, 21 August 2016

2016-08-21T09:52:39Z

← Older revision		Revision as of 09:52, 21 August 2016
Line 1:		Line 1:
	{{mininav\|[[Development]]\|[[Add-on development]]\|[[Add-on repositories]]}}		{{mininav\|[[Development]]\|[[Add-on development]]\|[[Add-on repositories]]}}

			{{outdated}}

			See [[Add-on_repositories]] for up-to-date reference documentation.

	When you have created your repository, feel free to add it to the [[3rd party add-on repositories]] list.		When you have created your repository, feel free to add it to the [[3rd party add-on repositories]] list.

ChadParry: Beautify bullets

2016-06-20T02:25:56Z

Beautify bullets

ChadParry: Add "--compressed" documentation

2016-06-17T22:01:54Z

Add "--compressed" documentation

← Older revision		Revision as of 22:01, 17 June 2016
Line 28:		Line 28:
	For example, if you have one zipped add-on and one add-on folder, then the following command will create the add-on repository in the current directory:		For example, if you have one zipped add-on and one add-on folder, then the following command will create the add-on repository in the current directory:
	./create_repository.py ~/my.spectacular.project.zip ~/development.project/		./create_repository.py ~/my.spectacular.project.zip ~/development.project/
	The <tt>--datadir</tt> option can specify a different directory for the repository. Also, a Git URL can have an optional <tt>#''branch''</tt> or <tt>#''tag''</tt> and optional <tt>:''path''</tt> at the end to designate the add-on's location within the repository.		The <tt>--datadir</tt> option can specify a different directory for the repository. The <tt>--compressed</tt> flag uses gzip on the addons.xml file. Also, a Git URL can have an optional <tt>#''branch''</tt> or <tt>#''tag''</tt> and optional <tt>:''path''</tt> at the end to designate the add-on's location within the repository.
	For example, if you are publishing two add-ons that are both stored within separate Git repositories, then the following command would create a repository:		For example, if you are publishing two add-ons that are both stored within separate Git repositories, then the following command would create a compressed repository:
	<nowiki>./create_repository.py --datadir=~/html/software/kodi \		<nowiki>./create_repository.py --datadir=~/html/software/kodi --compressed \
	https://github.com/chadparry/kodi-repository.chad.parry.org.git#release-1.0.0:repository.chad.parry.org \		https://github.com/chadparry/kodi-repository.chad.parry.org.git#release-1.0.0:repository.chad.parry.org \
	https://github.com/chadparry/kodi-plugin.program.remote.control.browser.git:plugin.program.remote.control.browser</nowiki>		https://github.com/chadparry/kodi-plugin.program.remote.control.browser.git:plugin.program.remote.control.browser</nowiki>

ChadParry: Publish a more powerful script for creating repositories

2016-06-17T08:40:28Z

Publish a more powerful script for creating repositories

Show changes

Roman V M: /* Things you will require */

2016-03-27T19:05:51Z

Things you will require

← Older revision		Revision as of 19:05, 27 March 2016
Line 27:		Line 27:
	addons_xml_generator.py		addons_xml_generator.py
	<source lang="python">		<source lang="python">
			#!/usr/bin/env python
	# *		# *
			# * Copyright (C) 2014-2015 Roman Miroshnychenko
	# * Copyright (C) 2012-2013 Garrett Brown		# * Copyright (C) 2012-2013 Garrett Brown
	# * Copyright (C) 2010 j48antialias		# * Copyright (C) 2010 j48antialias
Line 49:		Line 51:
	# * https://anarchintosh-projects.googlecode.com/files/addons_xml_generator.py		# * https://anarchintosh-projects.googlecode.com/files/addons_xml_generator.py

	~~""" addons.xml generator """~~		from __future__ import print_function

	import os		import os
	import sys		import sys
			from traceback import print_exc

	# Compatibility with 3.0, 3.1 and 3.2 not supporting u"" literals		# Compatibility with 3.0, 3.1 and 3.2 not supporting u"" literals
	if sys.version < '3':		if sys.version < '3':
	import codecs		import codecs
			open = codecs.open

	def u(x):		def u(x):
	return codecs.unicode_escape_decode(x)[0]		return codecs.unicode_escape_decode(x)[0]
Line 62:		Line 66:
	def u(x):		def u(x):
	return x		return x


	class Generator:		class Generator:
	"""		"""
	Generates a new addons.xml file from each addons addon.xml file		Generates a new addons.xml file from each addons addon.xml file
	and a new addons.xml.md5 hash file. Must be run from the root of		and a new addons.xml.md5 hash file. Must be run from the root of
	the checked-out repo. Only handles single depth folder structure.		the checked-out repo. Only handles single depth folder structure.
	"""		"""
	def __init__( self ):		def __init__(self):
	# generate files		# generate files
	self._generate_addons_file()		self._generate_addons_file()
Line 75:		Line 80:
	# notify user		# notify user
	print("Finished updating addons xml and md5 files")		print("Finished updating addons xml and md5 files")

	def _generate_addons_file( self ):		def _generate_addons_file(self):
	# addon list		# addon list
	addons = os.listdir( "." )		addons = os.listdir(".")
	# final addons text		# final addons text
	addons_xml = u("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<addons>\n")		addons_xml = u("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<addons>\n")
Line 85:		Line 90:
	try:		try:
	# skip any file or .svn folder or .git folder		# skip any file or .svn folder or .git folder
	if ( not os.path.isdir( addon ) or addon == ".svn" or addon == ".git" ): continue		if not os.path.isdir(addon) or addon == ".svn" or addon == ".git":
			continue
	# create path		# create path
	_path = os.path.join( addon, "addon.xml" )		_path = os.path.join(addon, "addon.xml")
	# split lines for stripping		# split lines for stripping
	xml_lines = open( _path, "r" , encoding="UTF-8").read().splitlines()		xml_lines = open(_path, "r", encoding="UTF-8").read().splitlines()
	# new addon		# new addon
	addon_xml = ""		addon_xml = ""
Line 95:		Line 101:
	for line in xml_lines:		for line in xml_lines:
	# skip encoding format line		# skip encoding format line
	if ( line.find( "<?xml" ) >= 0 ): continue		if (line.find("<?xml") >= 0):
			continue
	# add line		# add line
	if sys.version < '3':		if sys.version < '3':
	addon_xml += unicode( line.rstrip() + "\n~~", "UTF-8~~" )		addon_xml += unicode(line.rstrip() + "\n")
	else:		else:
	addon_xml += line.rstrip() + "\n"		addon_xml += line.rstrip() + "\n"
Line 105:		Line 112:
	except Exception as e:		except Exception as e:
	# missing or poorly formatted addon.xml		# missing or poorly formatted addon.xml
	print("Excluding %s for %s" % ( _path, e ))		print("Excluding %s for %s" % (_path, e))
	# clean and add closing tag		# clean and add closing tag
	addons_xml = addons_xml.strip() + u("\n</addons>\n")		addons_xml = addons_xml.strip() + u("\n</addons>\n")
	# save file		# save file
	self._save_file( addons_xml.encode( "UTF-8" ), file="addons.xml" )		self._save_file(addons_xml.encode("UTF-8"), file="addons.xml")

	def _generate_md5_file( self ):		def _generate_md5_file(self):
	# create a new md5 hash		# create a new md5 hash
	try:		try:
	import md5		import md5
	m = md5.new( open( "addons.xml", "r" ).read() ).hexdigest()		m = md5.new(open("addons.xml", "r").read()).hexdigest()
	except ImportError:		except ImportError:
	import hashlib		import hashlib
	m = hashlib.md5( open( "addons.xml", "r", encoding="UTF-8" ).read().encode( "UTF-8" ) ).hexdigest()		m = hashlib.md5(open("addons.xml", "r", encoding="UTF-8").read().encode("UTF-8")).hexdigest()

	# save file		# save file
	try:		try:
	self._save_file( m.encode( "UTF-8" ), file="addons.xml.md5" )		self._save_file(m.encode("UTF-8"), file="addons.xml.md5")
	except ~~Exception as e~~:		except:
	# oops		# oops
	print("An error occurred creating addons.xml.md5 file!~~\n%s~~" ~~% e~~)		print("An error occurred creating addons.xml.md5 file!")
			print_exc()
	def _save_file( self, data, file ):
			def _save_file(self, data, file):
	try:		try:
	# write data to the file (use b for Python 3)		# write data to the file (use b for Python 3)
	open( file, "wb" ).write( data )		open(file, "wb").write(data)
	except ~~Exception as e~~:		except:
	# oops		# oops
	print("An error occurred saving %s file!~~\n%s~~" % ( file~~, e~~ ))		print("An error occurred saving %s file!" % file)
			print_exc()


	if ( __name__ == "__main__" ):		if __name__ == "__main__":
	# start		# start
	Generator()		Generator()

Ned Scott: /* Video Tutorial */ I was advised to remove these

2016-01-16T12:05:27Z

Video Tutorial: I was advised to remove these

← Older revision		Revision as of 12:05, 16 January 2016
Line 2:		Line 2:

	When you have created your repository, feel free to add it to the [[3rd party add-on repositories]] list.		When you have created your repository, feel free to add it to the [[3rd party add-on repositories]] list.

	~~==Video Tutorial==~~
	~~{{youtube\|zm1pvAt5uvU}}~~

	~~[https://www.youtube.com/watch?v=zm1pvAt5uvU Video's Description.]~~
	*This video will help you create a Repository for Kodi. The video's steps are different from the written tutorial.
	* Helper Python script [https://github.com/virajkanwade/kodi-create-repo https://github.com/virajkanwade/kodi-create-repo]

	== Things you will require ==		== Things you will require ==

← Older revision		Revision as of 02:25, 20 June 2016
Line 5:		Line 5:
	== Things you will require ==		== Things you will require ==
	* Any HTTP server. A popular method is to use the svn or git source code servers of googlecode, gitorious and github.		* Any HTTP server. A popular method is to use the svn or git source code servers of googlecode, gitorious and github.
	- In your code project page, make sure you set up the correct version control system (source tab). Most skins use SVN.		** In your code project page, make sure you set up the correct version control system (source tab). Most skins use SVN.
	- This will get you the right checkout address (link) and folder structure.		** This will get you the right checkout address (link) and folder structure.
	* A folder containing one or more add-on.		* A folder containing one or more add-on.
	- Start by installing an svn program (like Tortoisesvn).		** Start by installing an svn program (like Tortoisesvn).
	- Right click the empty folder, choose 'SVN Checkout' to let it build a folder structure inside.		** Right click the empty folder, choose 'SVN Checkout' to let it build a folder structure inside.
	- Make sure you get asked for authentication (!), the folders look like your source code server.		** Make sure you get asked for authentication (!), the folders look like your source code server.
	- If you don't get asked for authentication check your server settings and http vs https links.		** If you don't get asked for authentication check your server settings and http vs https links.
	- Make a test.txt file in the trunk, right click to mark it as 'add' and use and use 'SVN Commit' on top folder.		** Make a test.txt file in the trunk, right click to mark it as 'add' and use and use 'SVN Commit' on top folder.
	* Make the following two files using the python code below. These 2 files are made from the addon.xml files in the folders below (from the addons). Where you can have your addon unzipped (or zipped as long as there is an addon.xml file next to it, that is always up to date with the one in the zip).		* Make the following two files using the python code below. These 2 files are made from the addon.xml files in the folders below (from the addons). Where you can have your addon unzipped (or zipped as long as there is an addon.xml file next to it, that is always up to date with the one in the zip).
	- A master addon'''s'''.xml file. This file contains metadata about all available add-ons.		** A master addon'''s'''.xml file. This file contains metadata about all available add-ons.
	- A checksum of the above file (this file only contains a hash of addons.xml).		** A checksum of the above file (this file only contains a hash of addons.xml).
	* A zipped repository add-on for distribution. This allows you to share your repository with others.		* A zipped repository add-on for distribution. This allows you to share your repository with others.
	- Easiest way is to have a look at another repository file and change the name, info and links.		** Easiest way is to have a look at another repository file and change the name, info and links.
	- You can also have a look at how other repos set up their folder structure.		** You can also have a look at how other repos set up their folder structure.

	You can use the <tt>create_repository.py</tt> script to generate the <tt>addons.xml</tt> metadata and the signature. The script will package up your add-ons from your source folders or it can fetch the sources directly from a Git repository.		You can use the <tt>create_repository.py</tt> script to generate the <tt>addons.xml</tt> metadata and the signature. The script will package up your add-ons from your source folders or it can fetch the sources directly from a Git repository.