Search.setIndex({"docnames": ["api", "examples", "index", "install"], "filenames": ["api.rst", "examples.rst", "index.rst", "install.rst"], "titles": ["API reference", "Using Python-Jenkins", "Python Jenkins", "Installing"], "terms": {"see": [0, 3], "exampl": [0, 2, 3], "us": [0, 2], "python": [0, 3], "jenkin": [0, 3], "except": 0, "jenkinsexcept": [0, 2], "gener": [0, 1, 3], "type": 0, "relat": 0, "failur": 0, "notfoundexcept": [0, 2], "A": [0, 1], "special": 0, "call": 0, "out": 0, "case": [0, 1], "receiv": 0, "404": 0, "emptyresponseexcept": [0, 2], "an": [0, 1, 2], "empti": [0, 1], "respons": [0, 1], "badhttpexcept": [0, 2], "broken": 0, "http": [0, 1, 2, 3], "timeoutexcept": [0, 2], "socket": [0, 1], "timeout": [0, 1], "class": [0, 3], "wrappedsess": [0, 2], "wrapper": [0, 2], "request": [0, 2], "session": 0, "overrid": 0, "verifi": 0, "properti": [0, 1], "ignor": 0, "requests_ca_bundl": 0, "environ": 0, "variabl": 0, "thi": [0, 1, 2], "i": [0, 1, 2, 3], "workaround": 0, "github": [0, 2], "com": 0, "kennethreitz": 0, "issu": 0, "3829": 0, "fix": 0, "3": [0, 2], "0": [0, 1], "merge_environment_set": [0, 2], "url": 0, "proxi": [0, 1], "stream": 0, "arg": [0, 1], "kwarg": 0, "check": 0, "merg": 0, "some": [0, 2], "set": [0, 1, 2], "return": 0, "dict": 0, "usernam": [0, 1], "none": 0, "password": [0, 1], "object": 0, "creat": [0, 1, 2], "handl": 0, "instanc": [0, 1], "all": [0, 1], "method": [0, 1, 3], "rais": 0, "paramet": [0, 1], "server": [0, 1, 2], "str": 0, "connect": [0, 1], "sec": 0, "default": 0, "int": 0, "maybe_add_crumb": [0, 2], "req": 0, "get_job_info": [0, 1, 2], "name": [0, 1], "depth": 0, "fetch_all_build": 0, "fals": 0, "get": [0, 2, 3], "job": [0, 2], "inform": [0, 1, 2], "dictionari": [0, 1], "json": 0, "If": [0, 1], "true": [0, 1], "build": [0, 2, 3], "retriev": [0, 1], "from": [0, 1], "otherwis": 0, "onli": [0, 1], "most": [0, 1], "recent": [0, 3], "100": 0, "come": 0, "expens": 0, "addit": 0, "which": [0, 2], "mai": [0, 1], "signific": 0, "amount": 0, "data": 0, "bool": 0, "get_job_info_regex": [0, 2], "pattern": 0, "folder_depth": 0, "folder_depth_per_request": 0, "10": [0, 2, 3], "list": [0, 2, 3], "contain": [0, 1, 2], "match": 0, "regex": 0, "folder": [0, 2, 3], "level": [0, 2], "search": [0, 2], "number": [0, 2], "fetch": 0, "onc": [0, 1], "get_all_job": [0, 2], "info": 0, "get_job_nam": [0, 2], "That": [0, 1], "roughli": 0, "ident": 0, "can": [0, 1, 2], "quickli": 0, "exist": [0, 1, 2], "access": 0, "without": 0, "caus": 0, "too": 0, "much": 0, "stress": 0, "side": 0, "debug_job_info": [0, 2], "job_nam": [0, 1], "print": [0, 1], "more": [0, 1, 2], "readabl": 0, "format": 0, "jenkins_open": [0, 2], "add_crumb": 0, "resolve_auth": 0, "bodi": 0, "jenkins_request": [0, 2], "util": 0, "routin": 0, "open": 0, "submit": [0, 2], "try": [0, 1], "add": [0, 1], "crumb": 0, "header": [0, 1], "befor": [0, 1, 2], "mayb": 0, "authent": [0, 1], "get_queue_item": [0, 2], "about": [0, 1], "queu": 0, "item": 0, "The": [0, 1, 2, 3], "have": [0, 1, 3], "why": 0, "kei": 0, "still": 0, "wait": [0, 2], "executor": 0, "execut": [0, 3], "run": [0, 1, 2, 3], "ha": [0, 3], "complet": [0, 2], "determin": 0, "queue": [0, 2], "get_build_info": [0, 1, 2], "next_build_numb": 0, "build_nam": 0, "nextbuildnumb": [0, 1], "output": 0, "build_job": [0, 1, 2], "time": [0, 1, 3], "import": [0, 1, 3], "sleep": 0, "build_info": [0, 1], "u": 0, "changeset": 0, "date": [0, 3], "2011": 0, "12": 0, "19t18": 0, "01": 0, "52": 0, "540557z": 0, "msg": 0, "test": [0, 1, 2], "revis": 0, "66": 0, "user": [0, 1], "unknown": 0, "path": 0, "edittyp": 0, "edit": 0, "file": [0, 1], "branch": 0, "demo": 0, "index": [0, 2, 3], "html": [0, 2, 3], "kind": 0, "svn": 0, "modul": [0, 2, 3], "eaa": 0, "svn01": 0, "i3": 0, "level3": 0, "builton": 0, "descript": 0, "artifact": 0, "relativepath": 0, "dist": 0, "87": 0, "19_18": 0, "57": 0, "war": 0, "displaypath": 0, "filenam": 0, "zip": 0, "timestamp": 0, "1324317717000": 0, "action": [0, 1], "service_nam": 0, "valu": [0, 1], "project_nam": 0, "anonym": 0, "shortdescript": 0, "start": [0, 1, 2, 3], "id": [0, 1], "keeplog": 0, "jenkins01": 0, "9080": 0, "build_war": 0, "culprit": 0, "absoluteurl": 0, "fullnam": [0, 1], "result": [0, 1], "success": 0, "durat": 0, "8826": 0, "fulldisplaynam": 0, "get_build_env_var": [0, 2], "env": 0, "var": 0, "workflow": 0, "injectenvvar": 0, "plugin": [0, 2], "instal": [0, 1], "get_build_test_report": [0, 2], "report": [0, 2], "get_queue_info": [0, 1, 2], "queue_info": [0, 1], "task": 0, "your_url": 0, "my_job": [0, 1], "color": 0, "aborted_anim": 0, "stuck": 0, "timer": 0, "buildabl": 0, "param": [0, 1], "buildablestartmillisecond": 0, "1315087293316": 0, "2": [0, 2], "532": 0, "alreadi": 0, "progress": 0, "eta": 0, "min": 0, "block": 0, "cancel_queu": [0, 1, 2], "cancel": 0, "get_info": [0, 2], "queri": 0, "master": [0, 1, 2], "includ": [0, 3], "view": [0, 2, 3], "retreiv": 0, "xpath": 0, "extract": 0, "your_url_her": 0, "blue": 0, "get_whoami": [0, 1, 2], "account": 0, "simpl": 0, "wai": [0, 2, 3], "your": [0, 1], "credenti": 0, "ar": [0, 1, 2, 3], "correct": 0, "current": 0, "me": 0, "john": [0, 1], "get_vers": [0, 1, 2, 3], "version": [0, 2, 3], "": [0, 1, 2], "1": [0, 2], "541": 0, "get_plugins_info": [0, 1, 2], "each": [0, 1], "raw": 0, "deprec": 0, "sinc": [0, 3], "4": [0, 2], "9": [0, 2], "get_plugin": [0, 2], "instead": [0, 1], "backupvers": 0, "delet": [0, 1, 2], "supportsdynamicload": 0, "hasupd": 0, "enabl": [0, 1, 2], "pin": 0, "downgrad": 0, "depend": 0, "wiki": [0, 1, 2, 3], "ci": 0, "org": [0, 2, 3], "displai": 0, "gearman": 0, "longnam": 0, "activ": 0, "shortnam": 0, "bundl": 0, "get_plugin_info": [0, 2], "specif": [0, 1], "pass": [0, 1], "short": 0, "long": 0, "must": 0, "exact": 0, "fresh": 0, "you": [0, 1, 2], "need": [0, 1, 2], "multipl": [0, 1], "recommend": 0, "multi": 0, "via": [0, 2], "either": 0, "helper": 0, "comparison": 0, "simplifi": 0, "also": 0, "allow": [0, 1], "when": [0, 1], "dump": 0, "transpar": 0, "unicod": 0, "string": [0, 1], "exactli": 0, "what": [0, 1], "wa": 0, "previous": 0, "j": 0, "get_job": [0, 1, 2], "view_nam": [0, 1], "present": 0, "limit": 0, "those": 0, "configur": [0, 1], "specifi": [0, 1], "In": 0, "would": 0, "equal": 0, "By": 0, "toplevel": 0, "disabl": [0, 2], "all_test": 0, "here": [0, 1, 2], "recurs": 0, "given": [0, 1], "usual": 0, "enough": 0, "singl": [0, 3], "easili": 0, "fit": 0, "On": 0, "mani": [0, 2], "effici": 0, "separ": 0, "henc": 0, "tree": 0, "than": [0, 1], "ask": [0, 1], "deepest": 0, "make": 0, "possibl": [0, 1, 3], "detect": 0, "actual": 0, "_class": 0, "field": 0, "everywher": 0, "miss": 0, "copy_job": [0, 1, 2], "from_nam": 0, "to_nam": 0, "copi": [0, 2], "Will": 0, "whenev": 0, "sourc": 0, "destin": 0, "won": 0, "t": 0, "same": 0, "throw": 0, "rename_job": [0, 2], "renam": 0, "new": [0, 2], "delete_job": [0, 1, 2], "perman": 0, "enable_job": [0, 1, 2], "disable_job": [0, 1, 2], "To": [0, 2, 3], "re": 0, "set_next_build_numb": [0, 1, 2], "next": [0, 2], "within": 0, "less": 0, "last": 0, "note": [0, 1, 3], "function": [0, 2], "next_bn": [0, 1], "50": [0, 1], "job_exist": [0, 2], "whether": 0, "jobs_count": [0, 1, 2], "total": 0, "assert_job_exist": [0, 2], "exception_messag": 0, "doe": [0, 1], "messag": 0, "create_job": [0, 1, 2], "config_xml": 0, "config": [0, 1], "text": 0, "get_job_config": [0, 1, 2], "xml": [0, 1], "reconfig_job": [0, 1, 2], "chang": 0, "build_job_url": [0, 2], "token": [0, 1], "trigger": 0, "setup": [0, 3], "requir": [0, 1, 2], "two": 0, "member": 0, "tupl": 0, "suppli": 0, "select": 0, "option": 0, "valid": 0, "five": 0, "minut": 0, "after": 0, "so": [0, 3], "should": [0, 1], "poll": 0, "soon": 0, "run_script": [0, 2], "script": 0, "node": [0, 2], "groovi": 0, "println": 0, "pluginmanag": 0, "window": 0, "slave": [0, 1], "ssh": 0, "translat": 0, "cv": 0, "nodelabelparamet": 0, "extern": 0, "monitor": 0, "mailer": 0, "jqueri": 0, "antisami": 0, "markup": 0, "formatt": 0, "maven": 0, "pam": 0, "auth": 0, "install_plugin": [0, 2], "include_depend": 0, "its": 0, "public": 0, "repositori": [0, 2], "repo": 0, "restart": 0, "jabber": 0, "stop_build": [0, 2], "stop": 0, "delete_build": [0, 2], "wipeout_job_workspac": [0, 2], "wipe": 0, "workspac": [0, 2], "get_running_build": [0, 2], "foo": [0, 1], "localhost": [0, 1], "15": 0, "get_nod": [0, 1, 2], "offlin": 0, "get_node_info": [0, 1, 2], "node_exist": [0, 2], "assert_node_exist": [0, 2], "delete_nod": [0, 2], "disable_nod": [0, 1, 2], "enable_nod": [0, 1, 2], "create_nod": [0, 1, 2], "numexecutor": 0, "nodedescript": [0, 1], "remotef": [0, 1], "lib": 0, "label": [0, 1], "exclus": [0, 1], "launcher": [0, 1], "hudson": [0, 1], "commandlaunch": 0, "launcher_param": [0, 1], "remot": 0, "filesystem": 0, "locat": 0, "associ": 0, "ti": 0, "launch": [0, 1], "launcher_command": 0, "launcher_ssh": [0, 1], "launcher_jnlp": 0, "launcher_windows_servic": 0, "get_node_config": [0, 2], "reconfig_nod": [0, 2], "get_build_console_output": [0, 2], "consol": 0, "get_view_nam": [0, 2], "assert_view_exist": [0, 2], "view_exist": [0, 2], "get_view": [0, 1, 2], "delete_view": [0, 1, 2], "create_view": [0, 1, 2], "reconfig_view": [0, 2], "get_view_config": [0, 1, 2], "get_promotion_nam": [0, 2], "promot": [0, 2], "assert_promotion_exist": [0, 2], "lack": 0, "promotion_exist": [0, 1, 2], "certain": 0, "get_promotions_info": [0, 2], "get_promot": [0, 1, 2], "delete_promot": [0, 1, 2], "create_promot": [0, 1, 2], "reconfig_promot": [0, 1, 2], "get_promotion_config": [0, 1, 2], "assert_fold": [0, 2], "cloudbe": [0, 2], "is_fold": [0, 2], "assert_credential_exist": [0, 2], "folder_nam": 0, "domain_nam": 0, "_": 0, "domain": 0, "credentail": 0, "credential_exist": [0, 2], "get_credential_info": [0, 2], "get_credential_config": [0, 2], "create_credenti": [0, 2], "delete_credenti": [0, 2], "reconfig_credenti": [0, 2], "reconfig": [0, 2], "list_credenti": [0, 2], "quiet_down": [0, 2], "prepar": 0, "shutdown": [0, 2], "No": 0, "prior": 0, "wait_for_normal_op": [0, 1, 2], "enter": 0, "normal": 0, "oper": 0, "mode": [0, 2], "second": [0, 1], "__init__": 0, "control": [0, 2], "how": [0, 1, 2, 3], "until": 0, "statu": 0, "becam": 0, "readi": [0, 2], "least": [0, 1], "length": 0, "It": [0, 1, 2], "ani": 0, "metadata": 0, "popul": 0, "input": 0, "accept": [0, 1], "argument": 0, "pluginvers": 0, "provid": [0, 2], "capabl": [0, 2], "pars": 0, "store": 0, "librari": 1, "manag": 1, "through": 1, "rest": [1, 2], "endpoint": 1, "below": 1, "further": [1, 3], "help": 1, "take": 1, "look": 1, "api": [1, 2, 3], "refer": [1, 2], "doc": [1, 2, 3], "detail": [1, 2, 3], "show": 1, "8080": 1, "myuser": 1, "mypassword": 1, "hello": 1, "abov": 1, "code": [1, 2], "attribut": 1, "For": [1, 2, 3], "426": 1, "onward": 1, "real": 1, "while": 1, "against": [1, 3], "support": [1, 2], "packag": [1, 2, 3], "pypi": 1, "obviou": 1, "pip": [1, 2, 3], "command": [1, 3], "might": 1, "well": 1, "tri": 1, "automat": [1, 2], "repli": 1, "401": 1, "unauthor": 1, "indic": 1, "automag": 1, "quick": 1, "just": 1, "follow": 1, "servlet": 1, "revers": 1, "sit": 1, "front": 1, "empty_config_xml": 1, "cool": 1, "empty_copi": 1, "reconfig_xml": 1, "parameter": 1, "param1": 1, "param2": 1, "last_build_numb": 1, "lastcompletedbuild": 1, "empty_view_config_xml": 1, "view_config": 1, "expect": 1, "document": [1, 2], "slave1": 1, "node_config": 1, "port": 1, "22": 1, "juser": 1, "credentialsid": 1, "10f3a3c8": 1, "be35": 1, "327e": 1, "b60b": 1, "a3e5edb0e45f": 1, "host": 1, "my": 1, "home": 1, "precis": 1, "empty_folder_xml": 1, "process": 1, "prom_job": 1, "snippet": 1, "promoted__build": 1, "jobpropertyimpl": 1, "activeprocessnam": 1, "prom_nam": 1, "where": 1, "ad": 1, "empty_promo_config_xml": 1, "promo_reconfig_xml": 1, "aid": 1, "continu": 1, "subsequ": 1, "attempt": 1, "assum": 1, "noth": 1, "listen": 1, "firewal": 1, "black": 1, "hole": 1, "30": 1, "els": 1, "fail": 1, "suffici": 1, "exit": 1, "underli": 1, "reject": 1, "slow": 1, "made": 1, "potenti": 1, "both": 1, "do": [1, 2], "aim": 2, "convention": 2, "higher": 2, "conveni": 2, "we": [2, 3], "like": 2, "autom": 2, "our": [2, 3], "thing": 2, "updat": 2, "put": 2, "quiet": 2, "down": 2, "wipeout": 2, "sudo": 2, "onlin": 2, "readthedoc": 2, "en": 2, "latest": 2, "bug": 2, "launchpad": 2, "net": 2, "git": 2, "openstack": [2, 3], "cgit": 2, "clone": 2, "gerrit": 2, "review": 2, "pleas": 2, "pull": 2, "thei": 2, "close": 2, "commun": 2, "jjb": 2, "channel": 2, "freenod": 2, "irc": 2, "network": 2, "contribut": 2, "avail": [2, 3], "infra": 2, "manual": 2, "Be": 2, "sure": 2, "lint": 2, "easiest": 2, "pre": 2, "commit": 2, "hook": 2, "Then": 2, "footnot": 2, "free": 2, "subset": 2, "full": 2, "paid": 2, "log": 2, "kerbero": 2, "work": 2, "5": 2, "6": 2, "7": 2, "8": 2, "unit": 2, "coverag": 2, "page": 2, "known": 3, "debian": 3, "base": 3, "distribut": 3, "easy_instal": 3, "been": 3, "ubuntu": 3, "oneir": 3, "11": 3, "apt": 3, "And": 3, "fedora": 3, "19": 3, "later": 3, "yum": 3, "develop": 3, "py": 3, "local": 3, "tox": 3, "e": 3, "under": 3, "keep": 3, "up": 3, "veri": 3, "everi": 3, "py27": 3, "ini": 3, "other": 3, "due": 3, "split": 3, "dedic": 3, "per": 3, "test_vers": 3, "jenkinsversiontest": 3, "differ": 3, "them": 3, "testr": 3, "measur": 3, "cover": 3}, "objects": {"": [[0, 0, 0, "-", "jenkins"]], "jenkins": [[0, 1, 1, "", "BadHTTPException"], [0, 1, 1, "", "EmptyResponseException"], [0, 2, 1, "", "Jenkins"], [0, 1, 1, "", "JenkinsException"], [0, 1, 1, "", "NotFoundException"], [0, 1, 1, "", "TimeoutException"], [0, 2, 1, "", "WrappedSession"], [0, 0, 0, "-", "plugins"]], "jenkins.Jenkins": [[0, 3, 1, "", "assert_credential_exists"], [0, 3, 1, "", "assert_folder"], [0, 3, 1, "", "assert_job_exists"], [0, 3, 1, "", "assert_node_exists"], [0, 3, 1, "", "assert_promotion_exists"], [0, 3, 1, "", "assert_view_exists"], [0, 3, 1, "", "build_job"], [0, 3, 1, "", "build_job_url"], [0, 3, 1, "", "cancel_queue"], [0, 3, 1, "", "copy_job"], [0, 3, 1, "", "create_credential"], [0, 3, 1, "", "create_job"], [0, 3, 1, "", "create_node"], [0, 3, 1, "", "create_promotion"], [0, 3, 1, "", "create_view"], [0, 3, 1, "", "credential_exists"], [0, 3, 1, "", "debug_job_info"], [0, 3, 1, "", "delete_build"], [0, 3, 1, "", "delete_credential"], [0, 3, 1, "", "delete_job"], [0, 3, 1, "", "delete_node"], [0, 3, 1, "", "delete_promotion"], [0, 3, 1, "", "delete_view"], [0, 3, 1, "", "disable_job"], [0, 3, 1, "", "disable_node"], [0, 3, 1, "", "enable_job"], [0, 3, 1, "", "enable_node"], [0, 3, 1, "", "get_all_jobs"], [0, 3, 1, "", "get_build_console_output"], [0, 3, 1, "", "get_build_env_vars"], [0, 3, 1, "", "get_build_info"], [0, 3, 1, "", "get_build_test_report"], [0, 3, 1, "", "get_credential_config"], [0, 3, 1, "", "get_credential_info"], [0, 3, 1, "", "get_info"], [0, 3, 1, "", "get_job_config"], [0, 3, 1, "", "get_job_info"], [0, 3, 1, "", "get_job_info_regex"], [0, 3, 1, "", "get_job_name"], [0, 3, 1, "", "get_jobs"], [0, 3, 1, "", "get_node_config"], [0, 3, 1, "", "get_node_info"], [0, 3, 1, "", "get_nodes"], [0, 3, 1, "", "get_plugin_info"], [0, 3, 1, "", "get_plugins"], [0, 3, 1, "", "get_plugins_info"], [0, 3, 1, "", "get_promotion_config"], [0, 3, 1, "", "get_promotion_name"], [0, 3, 1, "", "get_promotions"], [0, 3, 1, "", "get_promotions_info"], [0, 3, 1, "", "get_queue_info"], [0, 3, 1, "", "get_queue_item"], [0, 3, 1, "", "get_running_builds"], [0, 3, 1, "", "get_version"], [0, 3, 1, "", "get_view_config"], [0, 3, 1, "", "get_view_name"], [0, 3, 1, "", "get_views"], [0, 3, 1, "", "get_whoami"], [0, 3, 1, "", "install_plugin"], [0, 3, 1, "", "is_folder"], [0, 3, 1, "", "jenkins_open"], [0, 3, 1, "", "jenkins_request"], [0, 3, 1, "", "job_exists"], [0, 3, 1, "", "jobs_count"], [0, 3, 1, "", "list_credentials"], [0, 3, 1, "", "maybe_add_crumb"], [0, 3, 1, "", "node_exists"], [0, 3, 1, "", "promotion_exists"], [0, 3, 1, "", "quiet_down"], [0, 3, 1, "", "reconfig_credential"], [0, 3, 1, "", "reconfig_job"], [0, 3, 1, "", "reconfig_node"], [0, 3, 1, "", "reconfig_promotion"], [0, 3, 1, "", "reconfig_view"], [0, 3, 1, "", "rename_job"], [0, 3, 1, "", "run_script"], [0, 3, 1, "", "set_next_build_number"], [0, 3, 1, "", "stop_build"], [0, 3, 1, "", "view_exists"], [0, 3, 1, "", "wait_for_normal_op"], [0, 3, 1, "", "wipeout_job_workspace"]], "jenkins.WrappedSession": [[0, 3, 1, "", "merge_environment_settings"]]}, "objtypes": {"0": "py:module", "1": "py:exception", "2": "py:class", "3": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "exception", "Python exception"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"]}, "titleterms": {"api": 0, "refer": 0, "us": 1, "python": [1, 2], "jenkin": [1, 2], "exampl": 1, "1": 1, "get": 1, "version": 1, "2": 1, "log": 1, "kerbero": 1, "3": 1, "work": 1, "job": 1, "4": 1, "view": 1, "5": 1, "plugin": 1, "6": 1, "node": 1, "7": 1, "build": 1, "queue": 1, "8": 1, "cloudbe": 1, "folder": 1, "9": 1, "updat": 1, "next": 1, "number": 1, "promot": 1, "10": 1, "wait": 1, "readi": 1, "readm": 2, "develop": 2, "write": 2, "patch": 2, "instal": [2, 3], "without": 2, "setup": 2, "py": 2, "content": 2, "indic": 2, "tabl": 2, "document": 3, "unit": 3, "test": 3, "coverag": 3}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"API reference": [[0, "module-jenkins"]], "Using Python-Jenkins": [[1, "using-python-jenkins"]], "Example 1: Get version of Jenkins": [[1, "example-1-get-version-of-jenkins"]], "Example 2: Logging into Jenkins using kerberos": [[1, "example-2-logging-into-jenkins-using-kerberos"]], "Example 3: Working with Jenkins Jobs": [[1, "example-3-working-with-jenkins-jobs"]], "Example 4: Working with Jenkins Views": [[1, "example-4-working-with-jenkins-views"]], "Example 5: Working with Jenkins Plugins": [[1, "example-5-working-with-jenkins-plugins"]], "Example 6: Working with Jenkins Nodes": [[1, "example-6-working-with-jenkins-nodes"]], "Example 7: Working with Jenkins Build Queue": [[1, "example-7-working-with-jenkins-build-queue"]], "Example 8: Working with Jenkins Cloudbees Folders": [[1, "example-8-working-with-jenkins-cloudbees-folders"]], "Example 9: Updating Next Build Number": [[1, "example-9-updating-next-build-number"]], "Example 9: Working with Build Promotions": [[1, "example-9-working-with-build-promotions"]], "Example 10: Waiting for Jenkins to be ready": [[1, "example-10-waiting-for-jenkins-to-be-ready"]], "Python Jenkins": [[2, "python-jenkins"]], "README": [[2, "readme"]], "Developers": [[2, "developers"]], "Writing a patch": [[2, "writing-a-patch"]], "Installing without setup.py": [[2, "installing-without-setup-py"]], "Contents": [[2, "contents"]], "Indices and tables": [[2, "indices-and-tables"]], "Installing": [[3, "installing"]], "Documentation": [[3, "documentation"]], "Unit Tests": [[3, "unit-tests"]], "Test Coverage": [[3, "test-coverage"]]}, "indexentries": {"badhttpexception": [[0, "jenkins.BadHTTPException"]], "emptyresponseexception": [[0, "jenkins.EmptyResponseException"]], "jenkins (class in jenkins)": [[0, "jenkins.Jenkins"]], "jenkinsexception": [[0, "jenkins.JenkinsException"]], "notfoundexception": [[0, "jenkins.NotFoundException"]], "timeoutexception": [[0, "jenkins.TimeoutException"]], "wrappedsession (class in jenkins)": [[0, "jenkins.WrappedSession"]], "assert_credential_exists() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.assert_credential_exists"]], "assert_folder() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.assert_folder"]], "assert_job_exists() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.assert_job_exists"]], "assert_node_exists() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.assert_node_exists"]], "assert_promotion_exists() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.assert_promotion_exists"]], "assert_view_exists() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.assert_view_exists"]], "build_job() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.build_job"]], "build_job_url() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.build_job_url"]], "cancel_queue() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.cancel_queue"]], "copy_job() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.copy_job"]], "create_credential() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.create_credential"]], "create_job() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.create_job"]], "create_node() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.create_node"]], "create_promotion() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.create_promotion"]], "create_view() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.create_view"]], "credential_exists() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.credential_exists"]], "debug_job_info() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.debug_job_info"]], "delete_build() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.delete_build"]], "delete_credential() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.delete_credential"]], "delete_job() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.delete_job"]], "delete_node() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.delete_node"]], "delete_promotion() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.delete_promotion"]], "delete_view() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.delete_view"]], "disable_job() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.disable_job"]], "disable_node() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.disable_node"]], "enable_job() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.enable_job"]], "enable_node() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.enable_node"]], "get_all_jobs() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_all_jobs"]], "get_build_console_output() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_build_console_output"]], "get_build_env_vars() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_build_env_vars"]], "get_build_info() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_build_info"]], "get_build_test_report() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_build_test_report"]], "get_credential_config() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_credential_config"]], "get_credential_info() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_credential_info"]], "get_info() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_info"]], "get_job_config() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_job_config"]], "get_job_info() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_job_info"]], "get_job_info_regex() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_job_info_regex"]], "get_job_name() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_job_name"]], "get_jobs() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_jobs"]], "get_node_config() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_node_config"]], "get_node_info() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_node_info"]], "get_nodes() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_nodes"]], "get_plugin_info() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_plugin_info"]], "get_plugins() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_plugins"]], "get_plugins_info() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_plugins_info"]], "get_promotion_config() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_promotion_config"]], "get_promotion_name() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_promotion_name"]], "get_promotions() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_promotions"]], "get_promotions_info() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_promotions_info"]], "get_queue_info() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_queue_info"]], "get_queue_item() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_queue_item"]], "get_running_builds() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_running_builds"]], "get_version() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_version"]], "get_view_config() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_view_config"]], "get_view_name() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_view_name"]], "get_views() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_views"]], "get_whoami() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.get_whoami"]], "install_plugin() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.install_plugin"]], "is_folder() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.is_folder"]], "jenkins": [[0, "module-jenkins"]], "jenkins.plugins": [[0, "module-jenkins.plugins"]], "jenkins_open() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.jenkins_open"]], "jenkins_request() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.jenkins_request"]], "job_exists() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.job_exists"]], "jobs_count() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.jobs_count"]], "list_credentials() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.list_credentials"]], "maybe_add_crumb() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.maybe_add_crumb"]], "merge_environment_settings() (jenkins.wrappedsession method)": [[0, "jenkins.WrappedSession.merge_environment_settings"]], "module": [[0, "module-jenkins"], [0, "module-jenkins.plugins"]], "node_exists() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.node_exists"]], "promotion_exists() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.promotion_exists"]], "quiet_down() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.quiet_down"]], "reconfig_credential() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.reconfig_credential"]], "reconfig_job() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.reconfig_job"]], "reconfig_node() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.reconfig_node"]], "reconfig_promotion() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.reconfig_promotion"]], "reconfig_view() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.reconfig_view"]], "rename_job() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.rename_job"]], "run_script() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.run_script"]], "set_next_build_number() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.set_next_build_number"]], "stop_build() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.stop_build"]], "view_exists() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.view_exists"]], "wait_for_normal_op() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.wait_for_normal_op"]], "wipeout_job_workspace() (jenkins.jenkins method)": [[0, "jenkins.Jenkins.wipeout_job_workspace"]]}})