Difference between revisions of "Liblicense"

From Creative Commons
Jump to: navigation, search
(dreamy)
m (Reverted edits by CCID-jeremyhardin (talk) to last revision by Nathan Yergler)
 
(35 intermediate revisions by 9 users not shown)
Line 1: Line 1:
[[Category:Developer]]
+
{{Software Project
[[Category:Metadata]]
+
|Description=Low-level license metadata integration for applications.
[[Category:Desktop]]
+
|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
[[Category:Labs]]
+
|Code repository=http://code.creativecommons.org/viewgit/liblicense.git/
[[Category:Tools]]
+
|Mailing list=http://lists.ibiblio.org/mailman/listinfo/cc-devel
[[Category:Specification]]
+
}}
[[Category:Operating System]]
+
== What is liblicense? ==
[[Category:Technology]]
 
[[Category:Integration]]
 
  
__NOTOC__
+
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.
  
'''''Low-level license metadata integration for applications.'''''
+
* For a brief introduction video, check [http://blip.tv/file/1142312/ Asheesh Laroia talking about liblicense]
 
+
* To see '''liblicense in action''' take a look at [[License tagger]], the cross platform file metadata editor.
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 ==
 
== Features ==
Line 24: Line 21:
 
* No specific GUI library dependency allows applications to build the graphical chooser most appropriate for their platform.
 
* No specific GUI library dependency allows applications to build the graphical chooser most appropriate for their platform.
  
== Features in our dreams ==
+
== Future Improvements ==
 +
 
 
* Supports [[WebStatement|verification]] URLs for metadata verification
 
* Supports [[WebStatement|verification]] URLs for metadata verification
 
  
 
== Architecture ==
 
== Architecture ==
 
[[Image:System_architecture.png]]
 
[[Image:System_architecture.png]]
 +
 +
[[:Image:System_architecture.svg|Liblicense Architecture - SVG]]
  
 
== Bindings ==
 
== Bindings ==
Line 35: Line 34:
 
* [[Liblicense/Python|Python]]
 
* [[Liblicense/Python|Python]]
 
* [[Liblicense/Ruby|Ruby]]
 
* [[Liblicense/Ruby|Ruby]]
 +
 +
== Media ==
 +
 +
See [[Operating System Mockups]] for ideas on how '''liblicense''' could be integrated into various platforms.
  
 
== Download ==
 
== Download ==
  
* [https://sourceforge.net/project/showfiles.php?group_id=80503&package_id=238700 Latest Release from Sourceforge.net]
+
* [http://mirrors.creativecommons.org/software/liblicense/liblicense-0.8.1.tar.gz Latest Release tar.gz]
* Checkout liblicense module from [[SVN]]
 
 
* Debian and Ubuntu [http://mirrors.creativecommons.org/packages/ repositories].
 
* Debian and Ubuntu [http://mirrors.creativecommons.org/packages/ repositories].
 
* Read the [[Liblicense tutorial| tutorial]].
 
* Read the [[Liblicense tutorial| tutorial]].
 +
 +
=== 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 ==
 
== More Information ==
  
* [[Liblicense/Roadmap|Release History and Roadmap]]
+
* [[Liblicense/Releases|Release History]] and [[Liblicense/Roadmap|Roadmap]]
 
* [[Liblicense/Desktop_Integration|Desktop Integration]]
 
* [[Liblicense/Desktop_Integration|Desktop Integration]]
 
* [[Liblicense/Screenshots|Screenshots]]
 
* [[Liblicense/Screenshots|Screenshots]]
 
* [[License RDF|RDF Reference]]
 
* [[License RDF|RDF Reference]]
* [http://labs.creativecommons.org/~nathan/liblicense Library Documentation] (generated from source)
+
* [[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 ==
 
== See Also ==
  
 
* [[Companion File metadata specification]]  
 
* [[Companion File metadata specification]]  
* [[Tracker CC Indexing]]
+
* [[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 }}