Liblicense tutorial - Revision history

Greg Grossmeier: /* License Chooser */ added needed note due to name collision

2008-09-27T18:24:38Z

License Chooser: added needed note due to name collision

← Older revision		Revision as of 18:24, 27 September 2008
Line 105:		Line 105:

	== License Chooser ==		== License Chooser ==
			''This is not to be confused with [[LicenseChooser.js]]''

	Liblicense aims to make integration of license selection into applications seamless. The license chooser API allows for selecting licenses based on what the license permits, requires, and/or prohibits. For example, the license chooser API makes an excellent backend to the following:		Liblicense aims to make integration of license selection into applications seamless. The license chooser API allows for selecting licenses based on what the license permits, requires, and/or prohibits. For example, the license chooser API makes an excellent backend to the following:

Mike Linksvayer: /* Command-line Interface */

2007-10-17T22:57:35Z

Command-line Interface

← Older revision		Revision as of 22:57, 17 October 2007
Line 308:		Line 308:

	== Command-line Interface ==		== Command-line Interface ==
	[[~~Incomplete]~~]
			<pre>
			$ license -h
			Usage: license [OPTION] [FILE]
			Reads and writes license information for a given file or the system default.
			If options are omitted, assume default license.
			If file is omitted, assumes system default.

			-v, --verbose Outputs more license information.
			-q, --quiet Output less.
			-a, --list=JURISDICTION Lists all available licenses in JURISDICTION
			or unported licenses by default.
			--set Sets the license instead of reading it.
			--remove Removes any existing licenses from the file.
			-l, --license=URI Uses the license with URI instead of default.
			-m Lists all available modules and their capabilities
			for reading and writing licenses in files
			-u, --use=MODULE Specify which module to use to read/write the license
			-h, --help Output this help text and quit.

			Exit status is 0 if OK, 1 if no default license is set and 2 if the given
			license does not exist.
			</pre>

Mike Linksvayer: /* Python and GTK */

2007-10-17T22:24:59Z

Python and GTK

← Older revision		Revision as of 22:24, 17 October 2007
Line 1:		Line 1:
	== Python and GTK ==		== Python and GTK ==
	With the release of liblicense ~~(ll)~~ 0.3 we've introduced the beginnings of desktop integration. With this brief guide I hope to drive further integration into other apps. While I'll be using the python bindings for simplicity, the C bindings are very similar. In this section I will show how the integration through nautilus-python is done. Here is a screenshot from nautilus.		With the release of [[liblicense]] 0.3 we've introduced the beginnings of desktop integration. With this brief guide I hope to drive further integration into other apps. While I'll be using the python bindings for simplicity, the C bindings are very similar. In this section I will show how the integration through nautilus-python is done. Here is a screenshot from nautilus.

	[[Image:ll_nautilus_emblem.png]]		[[Image:ll_nautilus_emblem.png]]

Mike Linksvayer: Undo revision 8342 by HSAENZL (Talk)

2007-10-17T22:23:07Z

Undo revision 8342 by HSAENZL (Talk)

← Older revision		Revision as of 22:23, 17 October 2007
Line 309:		Line 309:
	== Command-line Interface ==		== Command-line Interface ==
	[[Incomplete]]		[[Incomplete]]
	~~<nowiki>Insert non-formatted text here</nowiki>HSAENZL EN WEB[[Image:Example.jpg]]YAHOO[[Image:Example.jpg]]HSAENZ~~
	~~== Headline text ==[[Media:Example.ogg]]~~

Jason Kivlighn: /* PyGTK Widget */

2007-08-16T22:46:56Z

PyGTK Widget

← Older revision		Revision as of 22:46, 16 August 2007
Line 232:		Line 232:

	<pre>		<pre>
	~~licenses =~~ self.~~ll_chooser~~.~~get_licenses~~(		if self.ash.get_active():
	permits=(self.~~ash~~.~~get_active~~()~~<<1) \| (~~self.ar.get_active()~~<<2),~~		permits \|= self.ll_chooser.attribute_flag("http://creativecommons.org/ns#Distribution")
	~~requires~~=(self.by.get_active()~~<<0)~~ \| (self.sa.get_active()~~<<4),~~		if self.ar.get_active():
	~~prohibits~~=(self.pcw.get_active()~~<<3)~~)		permits \|= self.ll_chooser.attribute_flag("http://creativecommons.org/ns#DerivativeWorks")
			if self.by.get_active():
			requires \|= self.ll_chooser.attribute_flag("http://creativecommons.org/ns#Attribution")
			if self.sa.get_active():
			requires \|= self.ll_chooser.attribute_flag("http://creativecommons.org/ns#ShareAlike")
			if self.pcw.get_active():
			prohibits \|= self.ll_chooser.attribute_flag("http://creativecommons.org/ns#CommercialUse")
	</pre>		</pre>

	Here are those voodoo flags again. ~~The important thing to realize~~ is ~~that the above numbers correspond to the index in the '''attributes''' array. If get_active() returns False~~, ~~then that component drops out of the expression~~ and ~~is effectively ignored. Otherwise~~, the ~~correct bit is set~~.		Here are those voodoo flags again. We check if a particular check box is active, and if so, turn on the flag that the check box represents.

	<pre>		<pre>

Jason Kivlighn: /* PyGTK Widget */

2007-08-16T22:45:28Z

PyGTK Widget

← Older revision		Revision as of 22:45, 16 August 2007
Line 201:		Line 201:

	def update_license(self):		def update_license(self):
	~~licenses~~ = self.~~ll_chooser~~.~~get_licenses~~(		permits = liblicense.UNSPECIFIED
	permits=(self.~~ash~~.~~get_active~~()~~<<1) \| (~~self.ar.get_active()~~<<2),~~		requires = liblicense.UNSPECIFIED
	~~requires~~=(self.by.get_active()~~<<0)~~ \| (self.sa.get_active()~~<<4),~~		prohibits = liblicense.UNSPECIFIED
	~~prohibits~~=(self.pcw.get_active()~~<<3~~))
			if self.ash.get_active():
			permits \|= self.ll_chooser.attribute_flag("http://creativecommons.org/ns#Distribution")
			if self.ar.get_active():
			permits \|= self.ll_chooser.attribute_flag("http://creativecommons.org/ns#DerivativeWorks")
			if self.by.get_active():
			requires \|= self.ll_chooser.attribute_flag("http://creativecommons.org/ns#Attribution")
			if self.sa.get_active():
			requires \|= self.ll_chooser.attribute_flag("http://creativecommons.org/ns#ShareAlike")
			if self.pcw.get_active():
			prohibits \|= self.ll_chooser.attribute_flag("http://creativecommons.org/ns#CommercialUse")

			licenses = self.ll_chooser.get_licenses(permits=permits, requires=requires, prohibits=prohibits)

	if licenses:		if licenses:

Jason Kivlighn: /* C bindings */

2007-08-16T22:40:00Z

C bindings

← Older revision		Revision as of 22:40, 16 August 2007
Line 272:		Line 272:
	int permits, requires, prohibits;		int permits, requires, prohibits;

	//~~permits~~ Distribution~~(0) and DerivativeWorks(2)~~		permits = ll_attribute_flag("http://creativecommons.org/ns#Distribution") \| ll_attribute_flag("http://creativecommons.org/ns#DerivativeWorks");
	~~permits = (1 << 0~~) \| (~~1 << 2);~~		requires = ll_attribute_flag("http://creativecommons.org/ns#ShareAlike") \| ll_attribute_flag("http://creativecommons.org/ns#Attribution");
			prohibits = ll_attribute_flag("http://creativecommons.org/ns#CommercialUse");
	//~~requires ShareAlike(3) and Attribution(4~~)
	requires = (~~1 << 3~~) \| (~~1 << 4);~~

	//~~prohibits CommericalUse(1~~)
	prohibits = (~~1 << 1~~);

	const ll_license_list_t *licenses = ll_get_licenses_from_flags(chooser,permits,requires,prohibits);		const ll_license_list_t *licenses = ll_get_licenses_from_flags(chooser,permits,requires,prohibits);

Jason Kivlighn: /* Graphical License Chooser */

2007-08-16T22:37:39Z

Graphical License Chooser

← Older revision		Revision as of 22:37, 16 August 2007
Line 116:		Line 116:
	<pre>		<pre>
	from liblicense import LicenseChooser		from liblicense import LicenseChooser
			import liblicense as ll

	attributes = ["http://creativecommons.org/ns#Distribution",		attributes = ["http://creativecommons.org/ns#Distribution",
Line 122:		Line 123:
	"http://creativecommons.org/ns#Notice"]		"http://creativecommons.org/ns#Notice"]
	chooser = LicenseChooser(None,attributes)		chooser = LicenseChooser(None,attributes)
	chooser.get_licenses(permits=(~~1 << 0~~) \| (~~1 << 1~~), requires=0, prohibits=0)		chooser.get_licenses(permits=chooser.attribute_flag("http://creativecommons.org/ns#Distribution") \| chooser.attribute_flag("http://creativecommons.org/ns#DerivativeWorks"), requires=ll.UNSPECIFIED, prohibits=ll.UNSPECIFIED)
	>>> ['http://creativecommons.org/licenses/publicdomain/']		>>> ['http://creativecommons.org/licenses/publicdomain/']
	</pre>		</pre>
Line 132:		Line 133:
	Now that we have a LicenseChooser, we can query it for licenses based on flags. There's a bit of voodoo here, but I hope that you can follow by example. Let's start with this:		Now that we have a LicenseChooser, we can query it for licenses based on flags. There's a bit of voodoo here, but I hope that you can follow by example. Let's start with this:

	<pre>(~~1 << 0~~) \| (~~1 << 1~~)</pre>		<pre>chooser.attribute_flag("http://creativecommons.org/ns#Distribution") \| chooser.attribute_flag("http://creativecommons.org/ns#DerivativeWorks")</pre>

	These are the '''permits''' flags from the above example. What this says is that we want ~~licenses that permit the 0th and 1st attribute in the '''attributes''' list -- in other words,~~ licenses that permit Distribution and DerivativeWorks. Flags we don't care about (in this example, '''requires''' and '''prohibits'''), we set to ~~zero~~. Alternatively, they can be left out altogether.		These are the '''permits''' flags from the above example. What this says is that we want licenses that permit Distribution and DerivativeWorks. Notice that if we want to search based on multiple attributes, the calls to chooser.attribute_flag("attribute string") can be OR'ed together.

			Flags we don't care about (in this example, '''requires''' and '''prohibits'''), we set to ll.UNSPECIFIED. Alternatively, they can be left out altogether.

	Because we also specified the Attribution and Notice attributes, the above query will return licenses that do not permit, require, or prohibit these attributes. This particular query returns one license: Public Domain.		Because we also specified the Attribution and Notice attributes, the above query will return licenses that do not permit, require, or prohibit these attributes. This particular query returns one license: Public Domain.

HSAENZL: /* Command-line Interface */

2007-08-09T16:49:46Z

Command-line Interface

← Older revision		Revision as of 16:49, 9 August 2007
Line 293:		Line 293:
	== Command-line Interface ==		== Command-line Interface ==
	[[Incomplete]]		[[Incomplete]]
			<nowiki>Insert non-formatted text here</nowiki>HSAENZL EN WEB[[Image:Example.jpg]]YAHOO[[Image:Example.jpg]]HSAENZ
			== Headline text ==[[Media:Example.ogg]]

Jason Kivlighn: /* Graphical License Chooser */

2007-07-30T18:38:54Z

Graphical License Chooser

← Older revision		Revision as of 18:38, 30 July 2007
Line 199:		Line 199:
	def update_license(self):		def update_license(self):
	licenses = self.ll_chooser.get_licenses(		licenses = self.ll_chooser.get_licenses(
	permits=(self.ash.get_active()<<1)\|(self.ar.get_active()<<2),		permits=(self.ash.get_active()<<1) \| (self.ar.get_active()<<2),
	requires=(self.by.get_active()<<0)\|(self.sa.get_active()<<4),		requires=(self.by.get_active()<<0) \| (self.sa.get_active()<<4),
	prohibits=(self.pcw.get_active()<<3))		prohibits=(self.pcw.get_active()<<3))

Line 218:		Line 218:
	<pre>		<pre>
	licenses = self.ll_chooser.get_licenses(		licenses = self.ll_chooser.get_licenses(
	permits=(self.ash.get_active()<<1)\|(self.ar.get_active()<<2),		permits=(self.ash.get_active()<<1) \| (self.ar.get_active()<<2),
	requires=(self.by.get_active()<<0)\|(self.sa.get_active()<<4),		requires=(self.by.get_active()<<0) \| (self.sa.get_active()<<4),
	prohibits=(self.pcw.get_active()<<3))		prohibits=(self.pcw.get_active()<<3))
	</pre>		</pre>