Django-git 项目技术文档

1. 安装指南

首先，通过svn获取项目代码：

git checkout git://github.com/sethtrain/django-git.git

然后，将 django-git/django_git 文件夹添加到你的 PYTHONPATH。

接下来，在 settings.py 文件中更新应用配置：

INSTALLED_APPS = (
    ...
    'django_git',
    ...
)

REPOS_ROOT = '/Users/seth/projects/git'

别忘了在 urls.py 文件中包含以下路由：

urlpatterns = patterns('',
    ...
    (r'^git/', include('django_git.urls')),
    ...
)

最后，收集静态文件，确保 AppDirectoriesFinder 在 STATICFILES_FINDERS 中：

./manage.py collectstatic -n
# 如果出现 js/jquery-1.2.6.min.js 文件和 js/commit.js 文件，继续执行以下命令
./manage.py collectstatic

如果 commit.js 有命名解析问题，请在 templates/django_git/commit.html 中重命名并相应移动文件。

2. 项目的使用说明

本项目使用 auto-render 装饰器，使得在其它项目/应用中使用此应用更为简单。若应用不想直接展示仓库/提交/分支，而是以自己的方式处理，只需在视图中调用 only_context=True：

@auto_render
def some_other_view(request, repo='', commit_id=''):
    if not commit_id or not repo: raise Http404

    ctx = django_git.views.commit(request, repo, commit_id, only_context=True)
    diffs = ctx['diffs']
    ...
    # 如果需要，也可以直接使用 django_git.utils：
    diffs = django_git.utils.get_commit(repo,commit).diffs

3. 项目API使用文档

项目API目前没有详细文档，但基本的使用方式已在上面提及。主要的API包括：

• django_git.views.commit：用于获取特定仓库和提交ID的提交详情。
• django_git.utils.get_commit：用于获取特定仓库和提交ID的提交对象。

4. 项目安装方式

本项目需要以下依赖：

• Pygments
• GitPython
• Django 1.3（或更高版本）

若想要开始使用 django-git，Hugh Brown 创建了 Django-git-tester 作为入门项目。

感谢以下贡献者：

• Christos Trochalakis
• Hugh Brown
• Fahrzin Hemmati