Flask-CI 0.3.20.1

Continuous Integration support for Flask

Continuous Integration with Flask

Table of contents

• Installation

• Usage

• Settings

• Reporters

• Contributing

• Creator

• Copyright and License

Installation

From PyPI:

$ pip install Flask-CI

Or by downloading the source and running:

$ python setup.py install

Latest git version:

$ pip install git+https://github.com/vicenteneto/flask-ci.git#egg=Flask-CI

Usage

Import the CICommand sub-manager:

from flask_ci.management.commands.ci import CICommand

Register the CICommand sub-manager to your primary Manager (within manage.py):

manager = Manager(create_app())
manager.add_command('ci', CICommand(settings))

Configure your continuous integration tool to run the following command:

$ python manage.py ci

Settings

• PROJECT_APPS

  A list/tuple of the custom apps you’ve written for your project. Reports are generated only for the apps from this list.

• CI_TASKS

  List of Continuous Integration reporters executed by python manage.py ci command.

  Default value: CI_TASKS = []

Reporters

Here is the reporters prebuild with Flask-CI.

• flask_ci.tasks.run_pylint

  Runs Pylint over selected apps. Task-specific settings: PYLINT_RCFILE

• flask_ci.tasks.run_nose

  Runs Nose over selected apps.

• flask_ci.tasks.run_pep8

  Runs Pep8 tool over selected apps. Task-specific settings: PEP8_RCFILE

Contributing

Have a bug or a feature request? Please, open a GitHub issue.

Creator

Vicente Neto

• <https://github.com/vicenteneto>

Copyright and license

Copyright 2016-, Vicente Neto. This project is licensed under the MIT License.