dj-git 0.3

Table of contents

• Installation

• Quick start

• Contribute

• Tests

• License

Installation

Install with pip:

pip install dj-git

Requirements:

• Python 3

• Django 1.9

• pygit2

• pygal

• pytz

Quick start

1. In settings.py, add ‘git’ to your INSTALLED_APPS like this:

   INSTALLED_APPS = [
       ...
       'git',
   ]

and specify the path to your Git repositories:

PROJECTS_DIR = "path/to/git_repositories"

If necessary, set your database configuration. For example, for PostgreSQL:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql_psycopg2',
        'NAME': '<dbname>',
        'USER': '<username>',
        'HOST': '<host>'
    }
}

2. In urls.py, include the git URLconf in your project this:

   from django.conf.urls import url, include
   
   urlpatterns = [
       ...
       url(r'^git/', include('git.urls')),
   ]

3. Run the following command to create the git models:

   python manage.py migrate

4. Update the Git projects:

   python manage.py updategitprojects

5. Start the development server:

   python manage.py runservser

and visit http://127.0.0.1:8000/admin/

6. Visit http://127.0.0.1:8000/git to see your Git projects

Tests

Run the tests with:

python runtests.py

Contribute

The project is still in its early stage. There are probably many aspects to improve and bugs to fix. Feel free to send pull requests.

License

MIT. See LICENSE for more details.