pschmitt/pyrundeck

Python REST API client for Rundeck 2.6+

🚮 Archived!

If you're interested in maintaining this package please get in touch with me at:

https://github.com/pschmitt/contact/issues/new

Rundeck REST API client

This is a Python REST API client for Rundeck 2.6+

Example

from pyrundeck import Rundeck

rundeck = Rundeck('http://rundeck-url',
                  token='sometoken',
                  api_version=32,  # this is not mandatory, it defaults to 18
                 )

run = rundeck.run_job(RUNDECK_JOB_ID, options={'option1': 'foo'})

running_jobs = rundeck.get_executions_for_job(job_id=RUNDECK_JOB_ID, status='running')

for job in running_jobs['executions']:
  print("%s is running" % job['id'])

A token can be generated in the 'profile' page of Rundeck. Alternatively you can login with a username and password.

Example using the file upload option

from pyrundeck import rundeck

rd = Rundeck(
        rundeck_url,
        username=username,
        password=password,
        verify=False,
        api_version=19  # Required for file upload option
    )
# Use the file_key returned in the response to reference the file when running a job
# Per documentation at https://docs.rundeck.com/docs/api/rundeck-api.html#upload-a-file-for-a-job-option
response = rd.upload_file(RUNDECK_JOB_ID, OPTION_NAME, FILE_NAME_STRING_OR_IOFILEWRAPPER)
file_key = response['options'][OPTION_NAME]
rd.run_job(RUNDECK_JOB_ID, options={OPTION_NAME: file_key})

See also

• https://github.com/marklap/rundeckrun

LICENSE

GPL3

pyrundeck's Issues

Release 0.9.6 contains forced debug loglevel

Hi there,
you had an pull request for issue #17, which got merged. But due to the fact that there is no new release, the version which is installed via pip3 is still using the old faulty code.

Please make a new minor release. 😅

Best regards
Shuro

Exception ModuleNotFoundError Error so python3.4 doesn't work fine

Traceback (most recent call last):
File "/usr/lib/python3.4/site-packages/pyrundeck/rundeck.py", line 12, in
from urlparse import urljoin
ImportError: No module named 'urlparse'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
File "", line 1, in
File "/usr/lib/python3.4/site-packages/pyrundeck/init.py", line 2, in
from .rundeck import Rundeck
File "/usr/lib/python3.4/site-packages/pyrundeck/rundeck.py", line 13, in
except ModuleNotFoundError:
NameError: name 'ModuleNotFoundError' is not defined

pyrundeck auth fails with rundeck 4.8.0

rundeck/rundeck#8013

Session cookies no longer work with 4.8.0 due to fixation attack changes.

Method to fetch project configuration

Hi,
Github won't let me open a MR, so here is the code snippet to get all the key/value pairs for a project's configuration :

    def get_project_config(self, project_name, format="xml"):
        url = "{}/project/{}/config".format(self.API_URL, project_name)
        return self.__get(url, format=format)

Cheers,
Xavier

Misbehaviour in stripping URLs

I have an instance whose URL is eg. https://myrundeeck.tld/instancename
When I try to connect, I get

requests.exceptions.HTTPError: 404 Client Error: Not Found for url: https://myrundeck.tld/api/32/projects

This error is as expected, since the part /instancename/ has been removed from the URL.
Thanks
Regards
Xavier

running the code

when im running the original code, without modifications, it just stay freeze.

Methods for gathering Job Definition

Hello.
I'm using the module in order to read the configured jobs in Rundeck, but there is a need to get the job's definition in order to validate some dynamic calls against the configured parameters.

So, I'd like to know how I could do to share with you the methods I created ( I cloned the Repository and I added get_job_def returning xml/yaml and get_job_meta returning xml ), to be able to use them and if possible to share those small developments too.

Thanks in advance for your answer.

best regards

Add tag support to #list_jobs

Add the ability to fetch jobs that match any of a given list of tags

Support for file uploads

Is this project open to a pull request for wrapping the file upload API of rundeck? The rundeck implementation can be found here. It looks like we'd just need to add a parameter to __post and __request to change the Content-type to octet/stream and add a data payload to the options kwarg.

Code documentation

I am using the package and I am having issues correctly assessing all the possibilities the class has. Could you please add a couple of documentation strings within the definition to access the options available.
example: "status" filtering.