Difference between revisions of "Source Repository Information"

From Creative Commons
Jump to: navigation, search
m (From Berlios: complete sentence)
m (Reverted edits by SimpleNg (talk) to last revision by Nkinkade)
(23 intermediate revisions by 9 users not shown)
Line 1: Line 1:
 
[[Category:Developer]]
 
[[Category:Developer]]
 +
[[Category:CC_Tech_Handbook]]
  
Creative Commons uses Subversion repositories at Sourceforge and [[CcTools Berlios|Berlios.de]] for maintaining project source code.  Subversion (svn) clients are included with Linux and Mac OS X.  Windows users can use [http://tortoisesvn.tigris.org/ Tortoise SVN].
+
Creative Commons uses [http://subversion.tigris.org Subversion] and [http://git.or.cz/ Git] repositories at http://code.creativecommons.org for source code management.  Subversion (svn) clients are included with Linux and Mac OS X.  Windows users can use [http://tortoisesvn.tigris.org/ Tortoise SVN].
  
== Available Modules ==
+
ccPublisher and some dependencies are still housed at [[CcTools Berlios|Berlios.de]]; those modules will be moved to code.creativecommons.org eventually.
 +
 
 +
== Checking Out Source ==
 +
 
 +
=== code.creativecommons.org ===
 +
 
 +
We moved our primary source repository from Sourceforge.net to code.creativecommons.org in March, 2008.  Note that we only support public key authentication for our repositories.
 +
 
 +
==== Subversion====
  
The Sourceforge Subversion repository contains the following modules:
+
* [http://code.creativecommons.org/viewsvn web view]
 +
* [http://code.creativecommons.org/svnroot read-only repository]
 +
* writeable checkout:
 +
      $svn co svn+ssh://svn@code.creativecommons.org/svnroot/project
 +
* write permission: email webmaster@creativecommons.org with your public key; if you had write permission at Sourceforge, please include your sourceforge.net username so we can map your key correctly.
  
<table align="left" valign="top" style="float:none;">
+
==== Git====
  <tr><th>module name      </th><th>description</th></tr>
 
  <tr><td>api              </td><td>Web services, generalized chooselicense.xsl implementation</td></tr>
 
  <tr><td>api_client        </td><td>Sample client implementation</td></tr>
 
  <tr><td>cchost            </td><td>The code for ccmixter.org and other ccHost installations</td></tr>
 
  <tr><td>cci              </td><td>Code for supporting iCommons web-sites; currently a Word Press theme.  In development.</td></tr>
 
  <tr><td>cclookup          </td><td>ccLookup</td></tr>
 
  <tr><td>ccpublisher1      </td><td>ccPublisher 1.x</td></tr>
 
  <tr><td>ccpublisher2      </td><td>ccPublisher 2 '''DEPRECATED''' ''Development for this project has moved to Berlios.de''</td></tr>
 
  <tr><td>ccrdf            </td><td>Python library for modeling licenses in RDF.</td></tr>
 
  <tr><td>cctagutils        </td><td></td></tr>
 
  <tr><td>cli_tools        </td><td>Command-line based tools for embedding and reading licenses.</td></tr>
 
  <tr><td>desktop_search    </td><td>Desktop search tools; Spotlight plugin for Mac OS X.</td></tr>
 
  <tr><td>pyarchive        </td><td>Python library for uploading works to the Internet Archive</td></tr>
 
  <tr><td>vendor_libs      </td><td>Vendor libraries that are used by other projects.  Modules are imported here if the project doesn't use svn, so we can use svn:externals, or if additional customization is required.</td></tr>
 
  <tr><td>zope_products    </td><td>CC developed zope products: the license engine, Plone skin and iStr.</td></tr>
 
  <tr><td>__cvs_import      </td><td>Data from the import from CVS that was either deprecated, crufted, or wrong.</td></tr>
 
</table>
 
  
== Checking Out Source ==
+
* [http://code.creativecommons.org/viewgit web view]
 +
* read-only access:
 +
      $git clone git://code.creativecommons.org/cc.license.git
 +
* read/write access:
 +
      $git clone git@code.creativecommons.org:cc.license
  
=== From Sourceforge ===
+
=== Berlios.de ===
  
The Sourceforge Subversion repository is accessed over https.  You can check out the entire repository (all projects, branches, tags, trunk and all; not recommended) with the following command:
+
See the [http://developer.berlios.de/svn/?group_id=5272 ccTools Subversion Information] page for details on checking out code hosted at Berlios (ccPublisher).
  
  $ svn co https://svn.sourceforge.net/svnroot/cctools
+
== Repositories ==
  
For a particular project, we specify a specify module.  For example, the following command can be used to check out the trunk of CcHost into a directory named <code>cchost</code>:
+
== Available Modules ==
  
  $ svn co https://svn.sourceforge.net/svnroot/cctools/cchost/trunk cchost
+
=== svn ===
  
Note that a username and password is only required when performing a write operation to the repository.  Subversion will prompt for a password as needed.  If Subversion prompts for a password for the incorrect username, simply press Enter, and Subversion will prompt for the username.
+
The Subversion repository contains the following modules:
  
=== From Berlios ===
+
<table align="left" valign="top" style="float:none;">
 +
  <tr><th>module name      </th><th>description</th></tr>
 +
  <tr><td>__cvs_import/</td><td>Inactive modules imported to Subversion from CVS circa 2005 (from sourceforge.net).</td></tr>
 +
  <tr><td>adobe_panel/</td><td>XMP license panel for legacy Adobe products</td></tr>
 +
  <tr><td>api/</td><td>CC API; now developed in git (cc.api)</td></tr>
 +
  <tr><td>api_client/</td><td>Wrappers for the API in Python, Java, etc; unmaintained.</td></tr>
 +
  <tr><td>asheesh_oneoffs/</td><td></td></tr>
 +
  <tr><td>autocurate/</td><td>Scripts to generate packages of content from sites like Flickr, etc, used for LiveCD.</td></tr>
 +
  <tr><td>banshee-license-verifier-plugin/</td><td>GSOC project: plugin for Banshee to verify web statement metadata pointed to in MP3 ID3 tags.</td></tr>
 +
  <tr><td>bbpress/</td><td>Tracking repository of bbpress</td></tr>
 +
  <tr><td>blog_analysis/</td><td>Return top blogs pointing to CC, as reported by Technorati. Used for targeted outreach.</td></tr>
 +
  <tr><td>buildout_script/</td><td>Buildout recipe for doing string substitution in script templates</td></tr>
 +
  <tr><td>campaign_widget/</td><td>Annual campaign javascript widget</td></tr>
 +
  <tr><td>cc-content.deb/</td><td></td></tr>
 +
  <tr><td>cc-sharp/</td><td>C# model for CC licenses</td></tr>
 +
  <tr><td>cc.engine/</td><td>License engine; now developed in git (cc.license)</td></tr>
 +
  <tr><td>cc.license/</td><td></td></tr>
 +
  <tr><td>ccbanshee/</td><td>GSOC project: Banshee plugin for displaying license information</td></tr>
 +
  <tr><td>cchost/</td><td>Legacy repository for CCHost, platform developed for CC Mixter</td></tr>
 +
  <tr><td>cci/</td><td>WordPress for legacy iCommons website</td></tr>
 +
  <tr><td>cclabs/</td><td>Legacy CC Labs experiments (DHTML chooser, et al)</td></tr>
 +
  <tr><td>cclib/</td><td></td></tr>
 +
  <tr><td>cclicense/</td><td></td></tr>
 +
  <tr><td>[[CcLookup|cclookup]]/</td><td>wxPython application for verifying web statements embedded in media files</td></tr>
 +
  <tr><td>[[CcNutch|ccnutch]]/</td><td>Nutch + cc search customizations</td></tr>
 +
  <tr><td>ccoer/</td><td>Early prototype of DiscoverEd, based on Scuttle</td></tr>
 +
  <tr><td>ccooo/</td><td>OpenOffice.org add-on, now developed in git.</td></tr>
 +
  <tr><td>ccpublisher1/</td><td>CC Publisher 1.x; 2.x code lives in the berlios.de repository/td></tr>
 +
  <tr><td>ccrdf/</td><td>A Python wrapper for CC Licenses</td></tr>
 +
  <tr><td>ccsearch/</td><td>CC Meta-search</td></tr>
 +
  <tr><td>cctagutils/</td><td>Python library for reading and writing CC's suggested web statements</td></tr>
 +
  <tr><td>ccwordpress/</td><td>creativecommons.org</td></tr>
 +
  <tr><td>cli_tools/</td><td>Command line tools for tagging and verifying licensed works.</td></tr>
 +
  <tr><td>desktop_search/</td><td>Prototype of Spotlight plugin for Mac OS X</td></tr>
 +
  <tr><td>experimental/</td><td></td></tr>
 +
  <tr><td>feed2map/</td><td></td></tr>
 +
  <tr><td>hooks/</td><td></td></tr>
 +
  <tr><td>i18n/</td><td>Translations, maintenance tools, now in git.</td></tr>
 +
  <tr><td>i18nedit/</td><td>Half finished prototype of web based PO editor, herder</td></tr>
 +
  <tr><td>jswidget/</td><td>Drop-in javascript widget for license selection</td></tr>
 +
  <tr><td>liblicense/</td><td>C library for manipulating license information embedded in files</td></tr>
 +
  <tr><td>liblicense-gnome/</td><td>gnome UI bindings for liblicense</td></tr>
 +
  <tr><td>liblicense-kde/</td><td>KDE UI bindings for liblicense</td></tr>
 +
  <tr><td>liblicense-sugar/</td><td>Sugar UI for liblicense</td></tr>
 +
  <tr><td>license-tutorial/</td><td></td></tr>
 +
  <tr><td>license.rdf/</td><td>License RDF files</td></tr>
 +
  <tr><td>license_xsl/</td><td>Legacy chooser XSLT and questions</td></tr>
 +
  <tr><td>livecontent/</td><td>Live CD with CC licensed content</td></tr>
 +
  <tr><td>log_analysis/</td><td></td></tr>
 +
  <tr><td>metadata_scraper/</td><td>Now developed in git as deedscraper</td></tr>
 +
  <tr><td>mozcc2/</td><td>Firefox add-on for displaying CC license information; superseded by OpenAttribute</td></tr>
 +
  <tr><td>nagios/</td><td>monitoring configuration</td></tr>
 +
  <tr><td>nc-survey/</td><td>Non-Commercial survey related code</td></tr>
 +
  <tr><td>oe_search/</td><td>PHP frontend for a Google CSE that acted as early DiscoverEd prototype</td></tr>
 +
  <tr><td>oenutch/</td><td>DiscoverEd</td></tr>
 +
  <tr><td>operator_userscript/</td><td>User script for Operator to display license information</td></tr>
 +
  <tr><td>opml/</td><td>Python library for reading and parsing OPML</td></tr>
 +
  <tr><td>pdf_callback/</td><td>Demonstration of a PDF with "phone home" capability</td></tr>
 +
  <tr><td>planet/</td><td>CC feed aggregator</td></tr>
 +
  <tr><td>pyarchive/</td><td>Python library for uploading works to Internet Archive</td></tr>
 +
  <tr><td>pywikipedia/</td><td>Python API for mediawiki, used for sending staff call emails</td></tr>
 +
  <tr><td>rdfadict/</td><td>Python dict-like interface for an RDFa parser</td></tr>
 +
  <tr><td>scicom/</td><td>Science Commons related projects, including MTA, SCA</td></tr>
 +
  <tr><td>scripts/</td><td></td></tr>
 +
  <tr><td>smw_tools/</td><td></td></tr>
 +
  <tr><td>stats/</td><td></td></tr>
 +
  <tr><td>themes/</td><td>Various theme projects</td></tr>
 +
  <tr><td>vendorlibs/</td><td>Vendor libraries that are used by other projects. Modules are imported here if the project doesn't use svn, so we can use svn:externals, or if additional customization is required</td></tr>
 +
  <tr><td>widgets/</td><td>Widgets for visualizing CC content and information.</td></tr>
 +
  <tr><td>wordpressmu/</td><td></td></tr>
 +
  <tr><td>wpLicense/</td><td>WordPress plugin for CC licensing; now developed in git/WP svn</td></tr>
 +
  <tr><td>www-i/</td><td>i.creativecommons.org</td></tr>
 +
  <tr><td>xmp/</td><td>Tools for embedding XMP metadata in PDF, JPEG and (future) other file types.</td></tr>
 +
  <tr><td>zope_products/ </td><td>CC developed zope products: the license engine, Plone skin and iStr.</td></tr>
 +
</table>
  
See the [http://developer.berlios.de/svn/?group_id=5272 ccTools Subversion Information] page for details on checking out code hosted at Berlios (ccPublisher).
+
=== git ===
 +
See the [http://code.creativecommons.org/viewgit git web interface] for repository descriptions.

Revision as of 16:47, 6 December 2013


Creative Commons uses Subversion and Git repositories at http://code.creativecommons.org for source code management. Subversion (svn) clients are included with Linux and Mac OS X. Windows users can use Tortoise SVN.

ccPublisher and some dependencies are still housed at Berlios.de; those modules will be moved to code.creativecommons.org eventually.

Checking Out Source

code.creativecommons.org

We moved our primary source repository from Sourceforge.net to code.creativecommons.org in March, 2008. Note that we only support public key authentication for our repositories.

Subversion

     $svn co svn+ssh://svn@code.creativecommons.org/svnroot/project
  • write permission: email webmaster@creativecommons.org with your public key; if you had write permission at Sourceforge, please include your sourceforge.net username so we can map your key correctly.

Git

     $git clone git://code.creativecommons.org/cc.license.git
  • read/write access:
     $git clone git@code.creativecommons.org:cc.license

Berlios.de

See the ccTools Subversion Information page for details on checking out code hosted at Berlios (ccPublisher).

Repositories

Available Modules

svn

The Subversion repository contains the following modules:

module name description
__cvs_import/ Inactive modules imported to Subversion from CVS circa 2005 (from sourceforge.net).
adobe_panel/ XMP license panel for legacy Adobe products
api/ CC API; now developed in git (cc.api)
api_client/ Wrappers for the API in Python, Java, etc; unmaintained.
asheesh_oneoffs/
autocurate/ Scripts to generate packages of content from sites like Flickr, etc, used for LiveCD.
banshee-license-verifier-plugin/ GSOC project: plugin for Banshee to verify web statement metadata pointed to in MP3 ID3 tags.
bbpress/ Tracking repository of bbpress
blog_analysis/ Return top blogs pointing to CC, as reported by Technorati. Used for targeted outreach.
buildout_script/ Buildout recipe for doing string substitution in script templates
campaign_widget/ Annual campaign javascript widget
cc-content.deb/
cc-sharp/ C# model for CC licenses
cc.engine/ License engine; now developed in git (cc.license)
cc.license/
ccbanshee/ GSOC project: Banshee plugin for displaying license information
cchost/ Legacy repository for CCHost, platform developed for CC Mixter
cci/ WordPress for legacy iCommons website
cclabs/ Legacy CC Labs experiments (DHTML chooser, et al)
cclib/
cclicense/
cclookup/ wxPython application for verifying web statements embedded in media files
ccnutch/ Nutch + cc search customizations
ccoer/ Early prototype of DiscoverEd, based on Scuttle
ccooo/ OpenOffice.org add-on, now developed in git.
ccpublisher1/ CC Publisher 1.x; 2.x code lives in the berlios.de repository/td>
ccrdf/ A Python wrapper for CC Licenses
ccsearch/ CC Meta-search
cctagutils/ Python library for reading and writing CC's suggested web statements
ccwordpress/ creativecommons.org
cli_tools/ Command line tools for tagging and verifying licensed works.
desktop_search/ Prototype of Spotlight plugin for Mac OS X
experimental/
feed2map/
hooks/
i18n/ Translations, maintenance tools, now in git.
i18nedit/ Half finished prototype of web based PO editor, herder
jswidget/ Drop-in javascript widget for license selection
liblicense/ C library for manipulating license information embedded in files
liblicense-gnome/ gnome UI bindings for liblicense
liblicense-kde/ KDE UI bindings for liblicense
liblicense-sugar/ Sugar UI for liblicense
license-tutorial/
license.rdf/ License RDF files
license_xsl/ Legacy chooser XSLT and questions
livecontent/ Live CD with CC licensed content
log_analysis/
metadata_scraper/ Now developed in git as deedscraper
mozcc2/ Firefox add-on for displaying CC license information; superseded by OpenAttribute
nagios/ monitoring configuration
nc-survey/ Non-Commercial survey related code
oe_search/ PHP frontend for a Google CSE that acted as early DiscoverEd prototype
oenutch/ DiscoverEd
operator_userscript/ User script for Operator to display license information
opml/ Python library for reading and parsing OPML
pdf_callback/ Demonstration of a PDF with "phone home" capability
planet/ CC feed aggregator
pyarchive/ Python library for uploading works to Internet Archive
pywikipedia/ Python API for mediawiki, used for sending staff call emails
rdfadict/ Python dict-like interface for an RDFa parser
scicom/ Science Commons related projects, including MTA, SCA
scripts/
smw_tools/
stats/
themes/ Various theme projects
vendorlibs/ Vendor libraries that are used by other projects. Modules are imported here if the project doesn't use svn, so we can use svn:externals, or if additional customization is required
widgets/ Widgets for visualizing CC content and information.
wordpressmu/
wpLicense/ WordPress plugin for CC licensing; now developed in git/WP svn
www-i/ i.creativecommons.org
xmp/ Tools for embedding XMP metadata in PDF, JPEG and (future) other file types.
zope_products/ CC developed zope products: the license engine, Plone skin and iStr.

git

See the git web interface for repository descriptions.