{"id":16615575,"url":"https://github.com/pschmitt/pyrundeck","last_synced_at":"2025-04-10T04:59:42.175Z","repository":{"id":8658376,"uuid":"59212521","full_name":"pschmitt/pyrundeck","owner":"pschmitt","description":"Python REST API client for Rundeck 2.6+","archived":false,"fork":false,"pushed_at":"2024-08-28T14:46:18.000Z","size":106,"stargazers_count":36,"open_issues_count":12,"forks_count":29,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-10-13T02:09:57.429Z","etag":null,"topics":["library","python","rundeck"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/pyrundeck/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pschmitt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["pschmitt"],"custom":["https://www.paypal.com/paypalme/pppschmitt"]}},"created_at":"2016-05-19T14:11:04.000Z","updated_at":"2024-08-28T14:46:08.000Z","dependencies_parsed_at":"2024-05-31T08:34:46.313Z","dependency_job_id":"678d1175-1fec-4ae7-9bdf-2a5dc3a35fb2","html_url":"https://github.com/pschmitt/pyrundeck","commit_stats":{"total_commits":80,"total_committers":15,"mean_commits":5.333333333333333,"dds":0.475,"last_synced_commit":"0d809db1ccb693aa1e3012558836b3bd803dd3ff"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschmitt%2Fpyrundeck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschmitt%2Fpyrundeck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschmitt%2Fpyrundeck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschmitt%2Fpyrundeck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pschmitt","download_url":"https://codeload.github.com/pschmitt/pyrundeck/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248161267,"owners_count":21057554,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["library","python","rundeck"],"created_at":"2024-10-12T02:09:55.245Z","updated_at":"2025-04-10T04:59:42.143Z","avatar_url":"https://github.com/pschmitt.png","language":"Python","funding_links":["https://github.com/sponsors/pschmitt","https://www.paypal.com/paypalme/pppschmitt"],"categories":[],"sub_categories":[],"readme":"# 🚮 Archived!\n\nIf you're interested in maintaining this package please get in touch with me at:\n\nhttps://github.com/pschmitt/contact/issues/new\n\n# Rundeck REST API client\n\n![PyPI](https://img.shields.io/pypi/v/pyrundeck)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/pyrundeck)\n![PyPI - License](https://img.shields.io/pypi/l/pyrundeck)\n![Python Lint](https://github.com/pschmitt/pyrundeck/workflows/Python%20Lint/badge.svg)\n\nThis is a Python REST API client for Rundeck 2.6+\n\n## Example\n\n```python\nfrom pyrundeck import Rundeck\n\nrundeck = Rundeck('http://rundeck-url',\n                  token='sometoken',\n                  api_version=32,  # this is not mandatory, it defaults to 18\n                 )\n\nrun = rundeck.run_job(RUNDECK_JOB_ID, options={'option1': 'foo'})\n\nrunning_jobs = rundeck.get_executions_for_job(job_id=RUNDECK_JOB_ID, status='running')\n\nfor job in running_jobs['executions']:\n  print(\"%s is running\" % job['id'])\n```\n\nA token can be generated in the 'profile' page of Rundeck. Alternatively you\ncan login with a username and password.\n\nExample using the file upload option\n\n```python\nfrom pyrundeck import rundeck\n\nrd = Rundeck(\n        rundeck_url,\n        username=username,\n        password=password,\n        verify=False,\n        api_version=19  # Required for file upload option\n    )\n# Use the file_key returned in the response to reference the file when running a job\n# Per documentation at https://docs.rundeck.com/docs/api/rundeck-api.html#upload-a-file-for-a-job-option\nresponse = rd.upload_file(RUNDECK_JOB_ID, OPTION_NAME, FILE_NAME_STRING_OR_IOFILEWRAPPER)\nfile_key = response['options'][OPTION_NAME]\nrd.run_job(RUNDECK_JOB_ID, options={OPTION_NAME: file_key})\n```\n\n## See also\n\n- https://github.com/marklap/rundeckrun\n\n## LICENSE\n\nGPL3\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpschmitt%2Fpyrundeck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpschmitt%2Fpyrundeck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpschmitt%2Fpyrundeck/lists"}