Metadata-Version: 1.1
Name: django-jenkins
Version: 0.16.1
Summary: Plug and play continuous integration with django and jenkins
Home-page: http://github.com/kmmbvnr/django-jenkins
Author: Mikhail Podgurskiy
Author-email: kmmbvnr@gmail.com
License: LGPL
Description: django-jenkins
        ==============
        
        Plug and play continuous integration with Django and 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://pypip.in/d/django-jenkins/badge.png
                :target: https://crate.io/packages/django-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``
        
        .. _Pylint: http://www.logilab.org/project/pylint
        
        - ``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``
        
        .. _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 Pylint compatible report for Jenkins.
        
          You should have flake8_ python package installed to run this task.
        
        .. _flake8: http://pypi.python.org/pypi/flake8
        
        - ``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.
        
        .. _SLOCCount: http://www.dwheeler.com/sloccount/
        
        
        Changelog
        ---------
        
        0.16.0 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!
        
        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.
        
        
Keywords: pyunit,unittest,testrunner,hudson,jenkins,django,pylint,pep8,pyflakes,csslint,jshint,coverage
Platform: Any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Testing
