django-jenkins

Plug and play continuous integration with Django and Jenkins

Installation

From PyPI:

$ pip install django-jenkins

Or by downloading the source and running:

$ python setup.py install

Latest git version:

$ pip install -e git+git://github.com/kmmbvnr/django-jenkins.git#egg=django-jenkins
$ pip install coverage

Installation for Python 3:

Works out of the box

Usage

Add 'django_jenkins' to your INSTALLED_APPS list. Configure Jenkins to run the following command:

$ ./manage.py jenkins --enable-coverage

This will create reports/ directory with junit xml, Coverage and Pylint reports.

For more details see the generic tutorial: https://sites.google.com/site/kmmbvnr/home/django-jenkins-tutorial

Settings

• PROJECT_APPS

  If present, it is supposed to be a list/tuple of django apps for Jenkins to run. Tests, reports, and coverage are generated only for the apps from this list.

• JENKINS_TASKS

  List of Jenkins reporters executed by ./manage.py jenkins command.

  Default value:

  JENKINS_TASKS = ()
  

• JENKINS_TEST_RUNNER

  The name of the class to use for starting the test suite for jenkins command. Class should be inherited from django_jenkins.runner.CITestSuiteRunner

Reporters

Here is the reporters prebuild with django-jenkins

• django_jenkins.tasks.run_pylint

  Runs Pylint over selected Django apps.

  Task-specific settings: PYLINT_RCFILE

• django_jenkins.tasks.run_csslint

  Runs CSS lint tools over app/static/*/*.css files. Creates CSS Lint compatible report for Jenkins

  You should have the csslint package installed

• django_jenkins.tasks.run_pep8

  Runs pep8 tool over selected Django apps. Creates Pylint compatible report for Jenkins

  You should have pep8 python package (>=1.3) installed to run this task.

  Task-specific settings: PEP8_RCFILE

• django_jenkins.tasks.run_pyflakes

  Runs Pyflakes tool over selected Django apps. Creates Pylint compatible report for Jenkins.

  You should have Pyflakes python package installed to run this task.

• django_jenkins.tasks.run_flake8

  Runs flake8 tool over selected Django apps. Creates pep8 compatible report for Jenkins.

  You should have flake8 python package installed to run this task.

• django_jenkins.tasks.run_sloccount

  Runs SLOCCount tool over selected Django apps. Creates sloccount plugin compatible report for Jenkins.

  You should have the SLOCCount program installed to run this task.

Changelog

GIT Version

• Flake8 >= 2.5.0 support

0.18.0 1985-10-26

• An exceptional release for the last 5 years issued not on 15th day of a month
• Drop python 2.6 support
• Drop django 1.6 support
• Add django 1.9 compatibility
• Drop scss-lint support (the tool no longer has xml output)
• Coverage>=4 compatibility

Contribution guide

• Set up local jenkins

• Set up django-jenkins:

  npm install jshint
  npm install csslint
  PATH=$PATH:$WORKSPACE/node_modules/.bin
  tox
  

• Ensure that everything works

• Modify the the only one thing

• Ensure that everything works again

• Fix pep8/pyflakes errors and minimize pylint's warninigs

• Pull request!

Authors

Created and maintained by Mikhail Podgurskiy <kmmbvnr@gmail.com>

Contributors: https://github.com/kmmbvnr/django-jenkins/graphs/contributors

Special thanks, for all github forks authors for project extensions ideas and problem identifications.