Difference between revisions of "Liblicense"

From Creative Commons
Jump to: navigation, search
(→‎System Overview)
m (Reverted edits by CCID-jeremyhardin (talk) to last revision by Nathan Yergler)
 
(112 intermediate revisions by 13 users not shown)
Line 1: Line 1:
−
== System Overview ==
+
{{Software Project
 +
|Description=Low-level license metadata integration for applications.
 +
|Bug tracker=http://code.creativecommons.org/issues/issue?status=-1,1,2,3,4,5,6,7&@sort=-activity&@search_text=&@dispname=liblicense&@filter=status,project&@group=priority&project=4&@columns=id,activity,title,creator,assignedto,status&@pagesize=50&@startwith=0
 +
|Code repository=http://code.creativecommons.org/viewgit/liblicense.git/
 +
|Mailing list=http://lists.ibiblio.org/mailman/listinfo/cc-devel
 +
}}
 +
== What is liblicense? ==
  
−
=== Purpose ===
+
liblicense provides a straight-forward way for developers to build license-aware applications.  liblicense utilizes a pluggable module system for reading and writing metadata from specific file types, allowing extensibility for specific content types.
−
To provide a simple way for developers to make their applications license aware.  Additionally, supplemental modules aim to provide a method for users to track licenses of files on their system.  This project complements [[Companion File metadata specification]] and [[Tracker CC Indexing]].
 
  
−
=== Architecture ===
+
* For a brief introduction video, check [http://blip.tv/file/1142312/ Asheesh Laroia talking about liblicense]
−
[[Image:Liblicense_system_architecture.png]]
+
* To see '''liblicense in action''' take a look at [[License tagger]], the cross platform file metadata editor.
  
−
[[Image:Liblicense_system_architecture.svg | svg version]]
+
== Features ==
  
−
== Config Modules ==
+
* Extract and write license information for files
−
* '''in_use'''() - returns whether or not the corresponding config system exists on the computer
+
* Supports enumeration of available licenses
−
* '''get'''() - returns the current default license uri
+
* Wraps internationalized license information for Creative Commons licenses
−
* '''set'''(uri) - sets the default license uri and returns 0 upon success (non-zero for errors)
+
* Bindings for dynamic languages (currently Python and Ruby)  
 +
* Extensible support for file types using module system
 +
* No specific GUI library dependency allows applications to build the graphical chooser most appropriate for their platform.
  
−
== I/O Modules ==
+
== Future Improvements ==
−
* '''mime_types''' - null terminated list of handled mime-types (all indicates external storage method which works for any file)
 
−
* '''read'''(filename) - returns the license uri for the given file (embedded license takes precedence)
 
−
* '''write'''(filename,uri) - writes the license uri for the given file
 
  
−
== License Files (.rdf) ==
+
* Supports [[WebStatement|verification]] URLs for metadata verification
−
=== Attributes ===
 
  
−
* cc:license
+
== Architecture ==
−
** about
+
[[Image:System_architecture.png]]
−
** permits
 
−
** requires
 
−
** prohibits
 
−
* dc:title - The human readable name of the license.
 
−
* dc:description - Description of the license.
 
−
* dc:coverage - The jurisdiction of the license.
 
−
* dc:language - The language of the license.
 
−
* dc:relation
 
−
** hasVersion - version number
 
−
** isReplacedBy - indicates retired license
 
−
** isBasedOn - indicates ported version
 
−
* dc:license - license the license is available under
 
−
* dc:type - always license
 
−
* dc:creator
 
−
* dc:publisher
 
−
* dc:identifier - URI of license
 
  
−
=== Example ===
+
[[:Image:System_architecture.svg|Liblicense Architecture - SVG]]
  
−
== Frontends ==
+
== Bindings ==
−
See [[Desktop Integration]]
 
  
−
== Timeline ==
+
* [[Liblicense/Python|Python]]
−
=== 6/18 ===
+
* [[Liblicense/Ruby|Ruby]]
−
* Finalize liblicense API.
 
  
−
=== 6/25 ===
+
== Media ==
−
* Write liblicense.
 
−
* Stub config and IO modules.
 
  
−
=== 7/2 ===
+
See [[Operating System Mockups]] for ideas on how '''liblicense''' could be integrated into various platforms.
−
* liblicense python bindings.
 
  
−
=== 7/9 ===
+
== Download ==
−
* Gconf config module.
 
−
* Nautilus IO module.
 
  
−
=== 7/16 ===
+
* [http://mirrors.creativecommons.org/software/liblicense/liblicense-0.8.1.tar.gz Latest Release tar.gz]
−
* Nautilus GUI frontend.
+
* Debian and Ubuntu [http://mirrors.creativecommons.org/packages/ repositories].
−
* Gnome control panel frontend.
+
* Read the [[Liblicense tutorial| tutorial]].
  
−
=== 7/23 ===
+
=== Developers: Using git ===
−
* Sugar Journal backend.
 
−
* Sugar frontend.
 
  
−
=== 7/30 ===
+
If you want to check out the source code and develop on it, use this command:
−
* Bug hunting.
 
−
* Frontend polishing.
 
  
−
=== 8/6 ===
+
git clone git://code.creativecommons.org/liblicense.git
−
{{stub}}
+
git submodule init
 +
git submodule update
  
−
=== 8/13 ===
+
That should give you a working copy you can commit to.  In case you wonder: the latter two commandsfill the directories
−
{{stub}}
+
* icons/jurisdictions
 +
* license.rdf
 +
* licenses
 +
with content from external repositories similar to ''svn:externals'' for Subversion.
  
−
=== 8/20 ===
+
== More Information ==
−
{{stub}}
+
 
 +
* [[Liblicense/Releases|Release History]] and [[Liblicense/Roadmap|Roadmap]]
 +
* [[Liblicense/Desktop_Integration|Desktop Integration]]
 +
* [[Liblicense/Screenshots|Screenshots]]
 +
* [[License RDF|RDF Reference]]
 +
* [[Liblicense/Metadata_Table|File Metadata Information]]
 +
* [http://code.creativecommons.org/doc/liblicense/ Library Documentation] (generated from source)
 +
* [[Buildbot]] helps test out liblicense on various platforms.
 +
 
 +
== See Also ==
 +
 
 +
* [[Companion File metadata specification]]
 +
* [[Tracker CC Indexing]] - also there is a great chart showing progress on reading/writing different filetypes (copied above).
 +
 
 +
{{Challenge Enabled}}
 +
 
 +
[[Category:Developer]]
 +
[[Category:Metadata]]
 +
[[Category:Desktop]]
 +
[[Category:Labs]]
 +
[[Category:Tools]]
 +
[[Category:Specification]]
 +
[[Category:Operating System]]
 +
[[Category:Technology]]
 +
[[Category:Integration]]
 +
 
 +
__NOTOC__
 +
{{lowercase}}

Latest revision as of 20:53, 23 September 2015

Description of Software Low-level license metadata integration for applications.
Bug Tracker Link to Bug Tracker
Code Repository Link to Code repository
Mailing List Link to Mailing list

What is liblicense?

liblicense provides a straight-forward way for developers to build license-aware applications. liblicense utilizes a pluggable module system for reading and writing metadata from specific file types, allowing extensibility for specific content types.

Features

  • Extract and write license information for files
  • Supports enumeration of available licenses
  • Wraps internationalized license information for Creative Commons licenses
  • Bindings for dynamic languages (currently Python and Ruby)
  • Extensible support for file types using module system
  • No specific GUI library dependency allows applications to build the graphical chooser most appropriate for their platform.

Future Improvements

Architecture

System architecture.png

Liblicense Architecture - SVG

Bindings

Media

See Operating System Mockups for ideas on how liblicense could be integrated into various platforms.

Download

Developers: Using git

If you want to check out the source code and develop on it, use this command:

git clone git://code.creativecommons.org/liblicense.git
git submodule init
git submodule update

That should give you a working copy you can commit to. In case you wonder: the latter two commandsfill the directories

  • icons/jurisdictions
  • license.rdf
  • licenses

with content from external repositories similar to svn:externals for Subversion.

More Information

See Also


Liblicense
Have an idea about this page? Want to help build the CC ecosystem? Check out the challenges related to Liblicense, or add one of your own below.
Open Challenges
{{#ask: Is Complete::no

Related To::Liblicense|format=table}}
Completed Challenges
{{#ask: Is Complete::yes

Related To::Liblicense|format=table}}
{{#forminput:Challenge|35 Challenge[related_to]=Liblicense }}


Retrieved from "https://wiki.creativecommons.org/index.php?title=Liblicense&oldid=114426"