Plug and play continuous integration with django and jenkins
Project description
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 (django 1.7 compatible):
$ 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 or tutorial for running django-jenkins on ShiningPanda CI https://docs.shiningpanda.com/tutorials/multi-databases/project.html
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. You should specify –all option to ignore this setting.
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 pylint 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 Pylint 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
0.16.2 2014-07-15
Django 1.7 compatibility
Support for all standard django test runner options
Migrations now our friends and checked by all linters, south_migrations are ignored
django_jenkins.tasks.with_coverage depricated, use command line option instead ./manage.py jenkins –enable-coverage
django_jenkins.tasks.run_graphmodels removed
django_jenkins.tasks.with_local_celery removed
Ability to run linters (pep8/pyflakes/pylint/csslint/jshint) from command line without tests removed (feel free to PR it back, if you need them)
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 everythig works
Modify the code
Ensure that everythig works again
Fix pep8/pyflakes errors and minimize pylint’s warninigs
Pull request!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.