zazu.plugins package¶

Submodules¶

zazu.plugins.astyle_styler module¶

astyle plugin for zazu.

class zazu.plugins.astyle_styler.AstyleStyler(options=[], excludes=[], includes=[])¶

Bases: zazu.styler.Styler

Astyle plugin for code styling.

static default_extensions()¶: Return the list of file extensions that are compatible with this Styler.

style_string(string)¶: Fix a string to be within style guidelines.

static type()¶: Return the string type of this Styler.

zazu.plugins.autopep8_styler module¶

Autopep8Styler plugin for zazu.

class zazu.plugins.autopep8_styler.Autopep8Styler(options=[], excludes=[], includes=[])¶

Bases: zazu.styler.Styler

Autopep8 plugin for code styling.

static default_extensions()¶: Return the list of file extensions that are compatible with this Styler.

style_string(string)¶: Fix a string to be within style guidelines.

static type()¶: Return the name of this Styler.

zazu.plugins.clang_format_styler module¶

ClangFormatStyler plugin for zazu.

class zazu.plugins.clang_format_styler.ClangFormatStyler(options=[], excludes=[], includes=[])¶

Bases: zazu.styler.Styler

ClangFormat plugin for code styling.

static default_extensions()¶: Return the list of file extensions that are compatible with this Styler.

style_string(string)¶: Fix a string to be within style guidelines.

static type()¶: Return the name of this Styler.

zazu.plugins.github_code_reviewer module¶

Enables code review using github.

class zazu.plugins.github_code_reviewer.GitHubCodeReview(github_pull_request)¶

Bases: zazu.code_reviewer.CodeReview

Adapts a github pull request object into a zazu CodeReview object.

assignee¶: Get the string assignee of the code review.

base¶: Return the branch name that is being merged to.

browse_url¶: Get the url to open to display the code review.

description¶: Get the string description of the code review.

head¶: Return the branch name that is being merged from.

id¶: Get the string id of the code review.

merged¶: Return true if the code review has been merged.

name¶: Get the string name of the code review.

status¶: Get the string state of the code review.

class zazu.plugins.github_code_reviewer.GitHubCodeReviewer(owner, repo)¶

Bases: zazu.code_reviewer.CodeReviewer

Implements zazu code review interface for GitHub.

connect()¶: Get handle to ensure that github credentials are in place.

create_review(title, base, head, body, issue=None)¶: Create a new code review (pull request).

static from_config(config)¶: Make a GitHubCodeReviewer from a config.

review(status=NotSet, head=NotSet, base=NotSet)¶: Get reviews (pull requests) matching the search criteria.

static type()¶: Return the name of this CodeReviewer.

zazu.plugins.github_issue_tracker module¶

Clasess that adapt GitHub for use as a zazu IssueTracker.

class zazu.plugins.github_issue_tracker.GitHubIssueAdaptor(github_issue, tracker_handle)¶

Bases: zazu.issue_tracker.Issue

Wraps a returned issue from PyGithub and adapts it to the zazu.issue_tracker.Issue interface.

assignee¶: Get the string assignee of the issue.

browse_url¶: Get the url to open to display the issue.

closed¶: Return True if the issue is closed.

description¶: Get the description of the issue.

id¶: Get the string id of the issue.

name¶: Get the name of the issue.

status¶: Get the status string of the issue.

type¶: Get the string type of the issue.

class zazu.plugins.github_issue_tracker.GitHubIssueTracker(owner, repo)¶

Bases: zazu.issue_tracker.IssueTracker

Implements zazu issue tracker interface for GitHub.

browse_url(issue_id)¶: Get the url to open to display the issue.

connect()¶: Get handle to ensure that github credentials are in place.

create_issue(project, issue_type, summary, description, component)¶

Create a new issue on github.

Parameters:	project (str) – meaningless for GitHub. issue_type (str) – meaningless for GitHub. summary (str) – a summary of the issue. description (str) – a detailed description of the issue. component (str) – meaningless for GitHub.

default_project()¶: Meaningless for GitHub.

static from_config(config)¶: Make a GitHubIssueTracker from a config.

issue(issue_id)¶: Get an issue by id.

issue_components()¶: Meaningless for GitHub.

issue_types()¶: There is only has 1 issue type on GitHub.

static type()¶: Return the name of this IssueTracker type.

static validate_id_format(id)¶

Validate that an id is the proper format for GitHub.

Parameters:	id (str) – the id to check.
Raises:	`zazu.issue_tracker.IssueTrackerError` – if the id is not valid.

zazu.plugins.jira_issue_tracker module¶

Clasess that adapt JIRA for use as a zazu IssueTracker.

class zazu.plugins.jira_issue_tracker.JiraIssueAdaptor(jira_issue, tracker_handle)¶

Bases: zazu.issue_tracker.Issue

Wraps a issue returned from the jiri api and adapts it to the zazu.issue_tracker.Issue interface.

assignee¶: Get the string assignee of the issue.

browse_url¶: Get the url to open to display the issue.

closed¶: Return True if the issue is closed.

description¶: Get the description of the issue.

id¶: Get the string id of the issue.

name¶: Get the name of the issue.

status¶: Get the status string of the issue.

type¶: Get the string type of the issue.

class zazu.plugins.jira_issue_tracker.JiraIssueTracker(base_url, default_project, components)¶

Bases: zazu.issue_tracker.IssueTracker

Implements zazu issue tracker interface for JIRA.

browse_url(id)¶: Get the url to open to display the issue.

connect()¶: Get handle to ensure that JIRA credentials are in place.

create_issue(project, issue_type, summary, description, component)¶

Create a new issue on JIRA.

Parameters:	project (str) – the JIRA project short string to create the issue in. issue_type (str) – the JIRA issue type to create. summary (str) – a summary of the issue. description (str) – a detailed description of the issue. component (str) – the JIRA component to associate with the issue.

default_project()¶: JIRA project associated with this tracker.

static from_config(config)¶: Make a JiraIssueTracker from a config.

issue(id)¶: Get an issue by id.

issue_components()¶: Components that are associated with this tracker.

issue_types()¶: Issue types that can be created by this tracker.

static type()¶: Return the name of this IssueTracker type.

static validate_id_format(id)¶

Validate that an id is the proper format for Jira.

Parameters:	id (str) – the id to check.
Raises:	`zazu.issue_tracker.IssueTrackerError` – if the id is not valid.

zazu.plugins.teamcity_build_server module¶

Defines helper functions for teamcity interaction.

class zazu.plugins.teamcity_build_server.TeamCityBuildServer(address, port=80, protocol='http')¶

Bases: zazu.build_server.BuildServer, pyteamcity.legacy.legacy.TeamCity

Extends the pyteamcity.Teamcity object to expose interfaces to create projects and build configurations.

static from_config(config)¶: Create new TeamCityBuildServer from a config dictionary.

static publish_artifacts(artifact_paths)¶: Publish artifacts based on the specifications in artifact_paths.

setup_component(component, repo_name, git_url)¶

Create or update TeamCity jobs associated with a build component.

Parameters:	component (zazu.build.ComponentConfiguration) – build component to create build configurations for. repo_name (str) – name of GitHub repo excluding organization. git_url (str) – URL to the git repo.

static type()¶: Return the name of this BuildServer type.

Module contents¶

Package file for zazu.plugin.