API

labelord

Open config file, set session and context.

Main function.

param:ctx Context, for Click param:config Config file param:token Token return:None

labelord [OPTIONS] COMMAND [ARGS]...

Options

-h, --help

Show this message and exit.

--version

Show the version and exit.

-c, --config <config>

Config file

-t, --token <token>

Token

list_labels

List labels.

Check if token provided. If do get all labels from repository and print them.

param:ctx Context, for Click param:repository Repository from which labels will be listed param:token Token param:tenv Token if set by environment variable return:None

labelord list_labels [OPTIONS] REPOSITORY

Options

-t, --token <token>

Token

--tenv <tenv>

Arguments

REPOSITORY

Required argument

Environment variables

GITHUB_TOKEN

Provide a default for --tenv

list_repos

List repos.

Check if token provided. I do get repositories and print them.

param:ctx Context, for Click param:token Token param:tenv Token if set by environment variable return:None

labelord list_repos [OPTIONS]

Options

-t, --token <token>

Token

--tenv <tenv>

Environment variables

GITHUB_TOKEN

Provide a default for --tenv

run

Run a labels update/replace.

Check if token provided. If do get labels (as template ones and changable ones) and do the magic - change them the way that all repositories has same (template) labels (dont forget update/replace mode).

param:ctx Context, for Click param:mode Mode of run [update, replace] param:template_repo Template repositary from which labels will be using param:all_repos Flag, if changes will be taken in all repositaries from list_repos command param:dry_run Flag, if changes will be canceled param:verbose Flag, set verbose mode param:quiet Flag, set quiet mode (no output) param:token Token param:tenv Token if set by environment variable return:None

labelord run [OPTIONS] MODE

Options

-r, --template-repo <template_repo>

Add a template repo.

-a, --all-repos

All available repos.

-d, --dry-run

Dry run

-v, --verbose

Verbose mode

-q, --quiet

Quiet mode

-t, --token <token>

Token

--tenv <tenv>

Arguments

MODE

Required argument

Environment variables

GITHUB_TOKEN

Provide a default for --tenv

run_server

Run a server with Flask app.

param:ctx Context, from Click param:host Hostname for interface (default 127.0.0.1) param:port Port for interface (default 5000) param:debug Flag, set debug mode return:None

labelord run_server [OPTIONS]

Options

-h, --host <host>

Host address

-p, --port <port>

Port

-d, --debug

Debug mode

Environment variables

FLASK_DEBUG

Provide a default for -d

labelord.labelord.main()

labelord.setupfile.printextra(level, text, label, err)

Print output.

Param:level Indicator of quiet/verbose/normal mode Param:text String to print out Param:label Label name Param:err Flag, if error occurs or dry-run Returns:None

labelord.setupfile.setup(session, token)

Set session - set token into request header.

Param:session Session for comunication with GitHub Param:token Set token to header Authentization Returns:session

class labelord.web.LabelordWeb(*args, **kwargs)

Bases: flask.app.Flask

Flask web interface class

inject_session(session)

Session setting.

Param:self Context Param:session Session for comunication with GitHub Returns:None

reload_config()

Config setting.

Open config file and set congiguration (token, webhook secret, ...), set a self context.

Param:self Context Returns:None

labelord.web.convert_str_to_link(text)

Convert the repo name to link, assistant function for GET requests.

Param:text String - repository name - to convert Returns:Link

labelord.web.get()

GET requests

Handle GET requests - print repositories and link to repositories.

Returns:render template Rendering page

labelord.web.post()

POST requests

Handle POST requests - chech if request from GitHub, if do make command according to POST request and send response.

Returns:response