django-jenkins
==============
Plug and play continuous integration with Django and Jenkins
.. image:: https://img.shields.io/pypi/v/django-jenkins.svg
:target: https://pypi.python.org/pypi/django-jenkins
.. image:: https://requires.io/github/kmmbvnr/django-jenkins/requirements.png?branch=master
:target: https://requires.io/github/kmmbvnr/django-jenkins/requirements/?branch=master
.. image:: https://badges.gitter.im/Join%20Chat.svg
:target: https://gitter.im/kmmbvnr/django-jenkins?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
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``
.. _Pylint: http://www.logilab.org/project/pylint
- ``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``
.. _pep8: http://pypi.python.org/pypi/pep8
- ``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.
.. _Pyflakes: http://pypi.python.org/pypi/pyflakes
- ``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.
.. _flake8: http://pypi.python.org/pypi/flake8
Changelog
---------
GIT Version
~~~~~~~~~~~~~~~~~~
* csslint/jshint/sccsLint/sloccount task removed (could be used as standalone tools)
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 warnings
* 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.
Raw data
{
"_id": null,
"home_page": "http://github.com/kmmbvnr/django-jenkins",
"name": "django-jenkins2",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "pyunit,unittest,testrunner,hudson,jenkins,django,pylint,pep8,pyflakes,csslint,scsslint,jshint,coverage",
"author": "Mikhail Podgurskiy",
"author_email": "kmmbvnr@gmail.com",
"download_url": "",
"platform": "Any",
"description": "django-jenkins\n==============\n\nPlug and play continuous integration with Django and Jenkins\n\n.. image:: https://img.shields.io/pypi/v/django-jenkins.svg\n :target: https://pypi.python.org/pypi/django-jenkins\n\n.. image:: https://requires.io/github/kmmbvnr/django-jenkins/requirements.png?branch=master\n :target: https://requires.io/github/kmmbvnr/django-jenkins/requirements/?branch=master\n\n.. image:: https://badges.gitter.im/Join%20Chat.svg\n :target: https://gitter.im/kmmbvnr/django-jenkins?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)\n\n\nInstallation\n------------\n\nFrom PyPI::\n\n $ pip install django-jenkins\n\nOr by downloading the source and running::\n\n $ python setup.py install\n\nLatest git version::\n\n $ pip install -e git+git://github.com/kmmbvnr/django-jenkins.git#egg=django-jenkins\n $ pip install coverage\n\nInstallation for Python 3::\n\n Works out of the box\n\nUsage\n-----\n\nAdd ``'django_jenkins'`` to your ``INSTALLED_APPS`` list.\nConfigure Jenkins to run the following command::\n\n $ ./manage.py jenkins --enable-coverage\n\nThis will create reports/ directory with junit xml, Coverage and Pylint\nreports.\n\nFor more details see the generic tutorial: https://sites.google.com/site/kmmbvnr/home/django-jenkins-tutorial\n\nSettings\n--------\n\n- ``PROJECT_APPS``\n\n If present, it is supposed to be a list/tuple of django apps for Jenkins to run.\n Tests, reports, and coverage are generated only for the apps from this list.\n\n- ``JENKINS_TASKS``\n\n List of Jenkins reporters executed by ``./manage.py jenkins`` command.\n\n Default value::\n\n JENKINS_TASKS = ()\n\n- ``JENKINS_TEST_RUNNER``\n\n The name of the class to use for starting the test suite for ``jenkins`` command.\n Class should be inherited from\n ``django_jenkins.runner.CITestSuiteRunner``\n\n\nReporters\n---------\n\nHere is the reporters prebuild with django-jenkins\n\n- ``django_jenkins.tasks.run_pylint``\n\n Runs Pylint_ over selected Django apps.\n\n Task-specific settings: ``PYLINT_RCFILE``\n\n.. _Pylint: http://www.logilab.org/project/pylint\n\n- ``django_jenkins.tasks.run_pep8``\n\n Runs pep8 tool over selected Django apps.\n Creates Pylint compatible report for Jenkins\n\n You should have pep8_ python package (>=1.3) installed to run this task.\n\n Task-specific settings: ``PEP8_RCFILE``\n\n.. _pep8: http://pypi.python.org/pypi/pep8\n\n- ``django_jenkins.tasks.run_pyflakes``\n\n Runs Pyflakes tool over selected Django apps.\n Creates Pylint compatible report for Jenkins.\n\n You should have Pyflakes_ python package installed to run this task.\n\n.. _Pyflakes: http://pypi.python.org/pypi/pyflakes\n\n- ``django_jenkins.tasks.run_flake8``\n\n Runs flake8 tool over selected Django apps.\n Creates pep8 compatible report for Jenkins.\n\n You should have flake8_ python package installed to run this task.\n\n.. _flake8: http://pypi.python.org/pypi/flake8\n\n\nChangelog\n---------\n\nGIT Version\n~~~~~~~~~~~~~~~~~~\n\n* csslint/jshint/sccsLint/sloccount task removed (could be used as standalone tools)\n\n\nContribution guide\n~~~~~~~~~~~~~~~~~~\n\n* Set up local jenkins\n* Set up django-jenkins::\n\n npm install jshint\n npm install csslint\n PATH=$PATH:$WORKSPACE/node_modules/.bin\n tox\n\n* Ensure that everything works\n* Modify the *the only one thing*\n* Ensure that everything works again\n* Fix pep8/pyflakes errors and minimize pylint's warnings\n* Pull request!\n\nAuthors\n-------\nCreated and maintained by Mikhail Podgurskiy <kmmbvnr@gmail.com>\n\nContributors: https://github.com/kmmbvnr/django-jenkins/graphs/contributors\n\nSpecial thanks, for all github forks authors for project extensions ideas and problem identifications.\n",
"bugtrack_url": null,
"license": "LGPL",
"summary": "Plug and play continuous integration with django and jenkins",
"version": "1.12.0",
"project_urls": {
"Homepage": "http://github.com/kmmbvnr/django-jenkins"
},
"split_keywords": [
"pyunit",
"unittest",
"testrunner",
"hudson",
"jenkins",
"django",
"pylint",
"pep8",
"pyflakes",
"csslint",
"scsslint",
"jshint",
"coverage"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a53e4143627e7c92f801de436762363d2263927750f015f9eee5a8e1e96ab16d",
"md5": "e8be13528d0239453ca0fff4d8b92773",
"sha256": "20dcc4bc0034c6cbfae0eb3e353a737569bec699b90e19ab1c2964a40c4c210f"
},
"downloads": -1,
"filename": "django_jenkins2-1.12.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e8be13528d0239453ca0fff4d8b92773",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 17544,
"upload_time": "2024-02-28T20:39:01",
"upload_time_iso_8601": "2024-02-28T20:39:01.162789Z",
"url": "https://files.pythonhosted.org/packages/a5/3e/4143627e7c92f801de436762363d2263927750f015f9eee5a8e1e96ab16d/django_jenkins2-1.12.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-28 20:39:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kmmbvnr",
"github_project": "django-jenkins",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "django-jenkins2"
}
JSON
