Labelbot Module Reference¶

bot¶

Event handler for AWS lambda.

This is the main module of labelbot, and contains the event handler for AWS lambda. If for any reason one would like to use a different service than AWS lambda, this is the functionality that needs to be changed.

auth¶

Functions for handling authentication procedures.

labelbot.auth.authenticate_request(shared_secret, body, signature)[source]¶

Checks if the MAC (message authentication code) sent in the request is really from GitHub.

Parameters:	shared_secret (`str`) – A secret shared between GitHub and the bot. body (`str`) – Body of the HTTP request. signature (`str`) – The header containing the MAC.
Return type:	`bool`
Returns:	True iff the signature is a MAC computed with the body of the request and the shared secret.

labelbot.auth.generate_installation_access_token(jwt_token, installation_id)[source]¶

Generates an installation access token using a JWT token and an installation id.

An installation access token is valid for 1 hour.

Parameters:	jwt_token (`str`) – a valid JWT token installation_id – the installation id of the app.
Return type:	`str`
Returns:	An installation access token from the GitHub API

labelbot.auth.generate_jwt_token(private_pem, app_id)[source]¶

Generates a JWT token valid for 10 minutes using the private key.

Parameters:	private_pem (`bytes`) – the private key that is used to generate a JWT the Application id (app_id) –
Return type:	`str`
Returns:	The JWT that was generated using the private key and the app id

labelbot.auth.get_pem(bucket_name, bucket_key)[source]¶

Reads a private PEM file from an S3 bucket.

Parameters:	bucket_name (`str`) – Name of the S3 bucket. bucket_key (`str`) – Bucket key for the PEM file.
Return type:	`bytes`
Returns:	Contents of the PEM file.

github_api¶

Functions for interacting with the GitHub API.

exception labelbot.github_api.APIError[source]¶: Raise when something goes wrong with the api.

labelbot.github_api.get_file_contents(owner, repo, filepath, access_token)[source]¶

Fetch the contents of a file in the repo.

Parameters:	owner (`str`) – User/Organization that owns the repo. repo (`str`) – Name of the repo. filepath (`str`) – Path to the file from the repo root. access_token (`str`) – A API access token.
Return type:	`str`
Returns:	The contents of the the specified file.

labelbot.github_api.get_labels(owner, repo, issue_nr, access_token)[source]¶

Get the labels from the given repository issue.

Parameters:	owner (`str`) – User/Organization that owns the repo. repo (`str`) – Name of the repo. issue_nr (`int`) – Number of the issue. access_token (`str`) – An installation access token for the repo.
Return type:	`List`[`str`]
Returns:	A list of labels.

labelbot.github_api.set_allowed_labels(owner, repo, issue_nr, issue_body, current_labels, access_token)[source]¶

Set the current labels plus any requested labels in the issue body that are also allowed by the .allowed-labels file.

Parameters:	owner (`str`) – User/Organization that owns the repo. repo (`str`) – Name of the repo. issue_nr (`int`) – Number of the issue. access_token (`str`) – An installation access token for the repo.
Return type:	`bool`

labelbot.github_api.set_labels(labels, owner, repo, issue_nr, access_token)[source]¶

Unconditionally set the provided labels on a repository issue.

Parameters:	labels (`Iterable`[`str`]) – A sequence of labels to set. owner (`str`) – User/Organization that owns the repo. repo (`str`) – Name of the repo. issue_nr (`int`) – Number of the issue. access_token (`str`) – An installation access token for the repo.
Return type:	`bool`
Returns:	True if the API request was succesful

parse¶

Parse label information from issue and config files.

labelbot.parse.parse_allowed_labels(text)[source]¶

Parse the allowd labels from the contents of a .allowed-labels file. Each line constitutes a single label. Lines starting with a # sign are ignored.

Parameters:	text (`str`) – The contents of a .allowed-labels file.
Return type:	`List`[`str`]
Returns:	A list of defined labels

labelbot.parse.parse_wanted_labels(text)[source]¶

Extract the labels defined by :label:`LABEL` tokens in a string.

Parameters:	text (`str`) – Typically an issue body with label markup.
Return type:	`List`[`str`]
Returns:	A list of extracted labels.