Difference between revisions of "CcValidator"
(added Software Projects form) |
|||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{Software Project | ||
| + | |Description=ccValidator is an on-line service which parses Creative Commons licenses, validates the RDF and displays their contents in human readable form. The service is available at http://validator.creativecommons.org. | ||
| + | |Bug tracker=http://code.creativecommons.org/issues/issue?status=-1,1,2,3,4,5,6,7&@sort=-activity&@search_text=&@dispname=Validator&@filter=status,project&@group=priority&project=15&@columns=id,activity,title,creator,assignedto,status&@pagesize=50&@startwith=0 | ||
| + | |Code repository=http://code.creativecommons.org/viewgit/validator.git/ | ||
| + | |Mailing list=http://lists.ibiblio.org/mailman/listinfo/cc-devel | ||
| + | }} | ||
[[Category:Developer]] | [[Category:Developer]] | ||
[[Category:Opensource]] | [[Category:Opensource]] | ||
[[Category:Tools]] | [[Category:Tools]] | ||
| − | + | == Background == | |
| − | This service was created in response to a list of [[Developer Challenges|developer challenges]] published by the Creative Commons. Suggestions and bug reports are always welcome | + | This service was first created in response to a list of [[Developer Challenges|developer challenges]] published by the Creative Commons and totally revamped during Google Summer of Code 2008. Suggestions and bug reports are always welcome. |
== Architecture == | == Architecture == | ||
| − | The validator consists of a | + | The validator consists of a Pylons web app called "validator" and a Python support module called "libvalidator." libvalidator handles RDF in many formats; RDF in a comment, RDFa, or inline RDF/XML. HTML is processed by html5lib, and the RDF is passed on to RDFlib. The CC RDF information is accessed via the cc.license Python module that wraps the Creative Commons RDF data. |
== Source Code == | == Source Code == | ||
| − | The current implementation is available | + | The current implementation is available in git. Setting up the validator requires three modules: |
| + | |||
| + | * cc.license | ||
| + | * libvalidator | ||
| + | * validator | ||
| + | |||
| + | (If you are not familiar with our git repository, read our [[Source Repository Information#git|documentation on our source repositories]].) | ||
| + | |||
| + | If you don't mind cluttering up your PYTHONPATH, the easiest way to get going to is to clone each of these and run "python setup.py install". After that, read the README in the validator repository; you can easily launch the validator web application, by default listening on localhost port 5000. | ||
| + | |||
| + | == Demonstration == | ||
| + | |||
| + | The validator can validate both our old RDF-in-a-comment and the recommendation from here on out, RDFa. The validator's [http://validator.creativecommons.org/ front page] links to these sample documents. | ||
== Additional Resources == | == Additional Resources == | ||
| − | + | '''Bug reports''' should be submitted via the [http://code.creativecommons.org/issues CC issue tracker]. | |
| − | + | ||
| − | * Historical development notes are in [[User:NathanYergler|Nathan Yergler's]] blog; the ccValidate-specific archive is located [http://yergler.net/blog/category/projects/ccvalidator/ here]. | + | * Historical development notes are in [[User:NathanYergler|Nathan Yergler's]] blog; the ccValidate-specific archive is located [http://yergler.net/blog/category/projects/ccvalidator/ here]. The historical ccValidator code is currently unavailable, but that codebase is unrelated to the current codebase (whose history is preserved in git). |
| + | * Hugo's posts about Google Summer of Code development process: | ||
| + | ** [http://labs.creativecommons.org/2008/05/26/license%E2%80%91oriented-metadata-validator-and-viewer-the-development-has-just-started/ Start of summer post announcing Hugo's plans] | ||
| + | ** [http://labs.creativecommons.org/2008/07/08/license-oriented-metadata-validator-and-viewer-libvalidator/ Middle of summer post explaining the separation of libvalidator] | ||
| + | ** [http://labs.creativecommons.org/2008/08/16/license-oriented-metadata-validator-and-viewer-summertime-is-winding-up/ Beta release at the end of GSoC] | ||
Latest revision as of 22:06, 30 July 2009
| Description of Software | ccValidator is an on-line service which parses Creative Commons licenses, validates the RDF and displays their contents in human readable form. The service is available at http://validator.creativecommons.org. |
|---|---|
| Bug Tracker | Link to Bug Tracker |
| Code Repository | Link to Code repository |
| Mailing List | Link to Mailing list |
Background
This service was first created in response to a list of developer challenges published by the Creative Commons and totally revamped during Google Summer of Code 2008. Suggestions and bug reports are always welcome.
Architecture
The validator consists of a Pylons web app called "validator" and a Python support module called "libvalidator." libvalidator handles RDF in many formats; RDF in a comment, RDFa, or inline RDF/XML. HTML is processed by html5lib, and the RDF is passed on to RDFlib. The CC RDF information is accessed via the cc.license Python module that wraps the Creative Commons RDF data.
Source Code
The current implementation is available in git. Setting up the validator requires three modules:
- cc.license
- libvalidator
- validator
(If you are not familiar with our git repository, read our documentation on our source repositories.)
If you don't mind cluttering up your PYTHONPATH, the easiest way to get going to is to clone each of these and run "python setup.py install". After that, read the README in the validator repository; you can easily launch the validator web application, by default listening on localhost port 5000.
Demonstration
The validator can validate both our old RDF-in-a-comment and the recommendation from here on out, RDFa. The validator's front page links to these sample documents.
Additional Resources
Bug reports should be submitted via the CC issue tracker.
- Historical development notes are in Nathan Yergler's blog; the ccValidate-specific archive is located here. The historical ccValidator code is currently unavailable, but that codebase is unrelated to the current codebase (whose history is preserved in git).
- Hugo's posts about Google Summer of Code development process:
