topic Re: Python library for Alteryx Gallery API in Dev Space

Python library for Alteryx Gallery API

nick_simmons — Tue, 31 Jul 2018 01:36:30 GMT

Our team has just published an accessible and easy to use Python library to connect to the Alteryx Gallery API.

Check it out at:

https://github.com/Theamazingdp/AlteryxGalleryAPI

Authored by David Pryor and Co-Authored by Nick Simmons and Ritu Gowlikar

Re: Python library for Alteryx Gallery API

JPKa — Fri, 31 Aug 2018 17:19:51 GMT

This is great! I've got one of these as well, from a couple of years ago:

https://github.com/johnkabler/PyRyx

I'd love to contribute to this, since mine was more tailored for working with pandas dataframes.

Re: Python library for Alteryx Gallery API

cam_w — Wed, 21 Nov 2018 03:22:13 GMT

@nick_simmons - Thank you!

I was looking for a simplier solution to Visual Studio, and this was it. I simply wrapped your excellent work into a small command line interface that I am able to call from another application.

If you're interested, check out my changes here:

https://github.com/daqieq/AlteryxGalleryAPI

N.B. - For others looking for something like this ... my code is raw, offered 'as is' with no warranty ... ;) and requires additional coding to be complete and ready for production usage.

Re: Python library for Alteryx Gallery API

jeffv — Tue, 18 Dec 2018 02:20:48 GMT

All,

After a brief message to @cam_w he suggested I bring the questions to the community.

I pulled down his cli python program, got my python working to run the program ayx-cli.py. Probably some simple questions but hopefully someone can be kind enough to steer me in the right direction.

I run the program as: python ayx-cli.py -s "https://alteryx.<mydomain>.com/" "myserverkey" "secretkey"

I get the error back as:

usage: ayx-cli.py [-h] (-s S | -t T) [-a A] [-v] server key secret
ayx-cli.py: error: the following arguments are required: secret

Seems to me -s is to submit the job giving it three parameters "server name", "server key", and "secret key" but maybe I'm missing it.

I believe I understand the api but just need to figure out the cli program a bit more.

Thanks,

Jeff

Re: Python library for Alteryx Gallery API

nick_simmons — Tue, 18 Dec 2018 03:06:44 GMT

Sorry for the radio silence, haven't checked this in a while.

@c2willis - This is awesome work! Thank you for contributing.

@JKPa - PyRyx looks awesome. Any collaboration would be welcome!

Re: Python library for Alteryx Gallery API

jeffv — Tue, 18 Dec 2018 03:35:48 GMT

Looking at it further... using -s parameter requires the application id so I added that. Now because I'm connecting with https I believe I'm getting an error (maybe about wrong port?). Can server be "https://alteryx.mydomain.com/"?

In code I changed it in one spot to https but get the following error(s):

C:\Users\vandeje1\Documents\Python_Scripts>python ayx-cli.py -s "appid" "https://alteryx.<mydomain>.com/" "key1" "key2"
HTTPSConnectionPool(host='https', port=443): Max retries exceeded with url: //alteryx.mydomain.com//gallery/api/v1/workflows/subscription/?oauth_consumer_key=key1&oauth_nonce=g6X9I&oauth_signature_method=HMAC-SHA1&oauth_timestamp=1545103686&oauth_version=1.0&search=key2&oauth_signature=u4PXf2%2Bw6q1MC9KjfKbqqirsrtY%3D (Caused by NewConnectionError('<urllib3.connection.VerifiedHTTPSConnection object at 0x000002A0CCAD3E48>: Failed to establish a new connection: [Errno 11001] getaddrinfo failed'))

Thanks,

Jeff

Re: Python library for Alteryx Gallery API

cam_w — Tue, 18 Dec 2018 23:55:37 GMT

Hi @jeffv

Don't pass the https:// in the command line. If you look at line 31 of my ayx-cli.py file, it prepends the http:// to complete the URL. If you want to use https, change it on line 31.

Your call to the cli should be something like this:

python ayx-cli.py alteryx.<mydomain>.com key1 key2 -s appid

Re: Python library for Alteryx Gallery API

jeffv — Wed, 19 Dec 2018 06:57:14 GMT

Hi,

I tried above approach but I receive the following.

python ayx-cli.py alteryx.myngc.com key1 key2 -s appid
HTTPSConnectionPool(host='alteryx.mydomain.com', port=443): Max retries exceeded with url: /gallery/api/v1/workflows/subscription/?oauth_consumer_key=key1&oauth_nonce=Jn5Sw&oauth_signature_method=HMAC-SHA1&oauth_timestamp=1545202254&oauth_version=1.0&search=appid&oauth_signature=0t6XLsLdNk%2FVtdtn7VYT6U4oBqQ%3D (Caused by SSLError(SSLError("bad handshake: Error([('SSL routines', 'ssl3_get_server_certificate', 'certificate verify failed')])")))
HTTPSConnectionPool(host='alteryx.myngc.com', port=443): Max retries exceeded with url: /gallery/api/v1/workflows/subscription/?oauth_consumer_key=key1&oauth_nonce=Jn5Sw&oauth_signature_method=HMAC-SHA1&oauth_timestamp=1545202254&oauth_version=1.0&search=appid&oauth_signature=0t6XLsLdNk%2FVtdtn7VYT6U4oBqQ%3D (Caused by SSLError(SSLError("bad handshake: Error([('SSL routines', 'ssl3_get_server_certificate', 'certificate verify failed')])")))

any thoughts? I'm a bit lost....

Thanks,

Jeff

Re: Python library for Alteryx Gallery API

jeffv — Thu, 20 Dec 2018 15:46:22 GMT

Reaching out again...

Should the -s parameter be followed with an AppID such as 5c1bb17739745f1db459ccf9 or should it have the application name?

Either way I still get an error:

(Caused by SSLError(SSLError("bad handshake: Error([('SSL routines', 'ssl3_get_server_certificate', 'certificate verify failed')])")))

Running through the gallery testing of api it seems to work but the python cli seems to fail with above error. Likely my misunderstanding but can't seem to get past it.

Anybody able to shed some light?

Jeff

Re: Python library for Alteryx Gallery API

cam_w — Fri, 21 Dec 2018 17:23:24 GMT

Hi @jeffv

Are you using https? My server installation doesn't work with https which is why I used http. Check this by typing https:// infront of your normal url for the web based API testing page:

https://<servername>/gallery/api-docs/

If that doesn't work, then replace https with http in the ayx-cli.py file.

If it does work, then check the port that your server is using. The error message shows port 443 (?) so just make sure that your Alteryx Server is configured to use that port.

I would make friends with the colleagues that are maintaining the server! They will be your best friend here.

The -s (search) parameter functions the same as the search parameter on the API interactive documentation web page. You can search for a workflow name, but my experience is that using the app id works best.

Re: Python library for Alteryx Gallery API

jeffv — Fri, 21 Dec 2018 18:31:04 GMT

Hi,

Yes using https://<servername>/gallery/api-docs/ works fine however changing line 31 to https and running it still comes up with the error. I have reached out to server folks and submitted a support case.

Using the api-doc calls seems to work. I can submit and see status when completed. However, using the python approach doesn't seem to work. Hmm not sure what I may be doing wrong.

Thanks,

Jeff

Re: Python library for Alteryx Gallery API

joshualherr — Fri, 23 Apr 2021 17:30:54 GMT

We ran into a similar issue with our environments. Our dev environment does not have SSL enabled and I was able to use the Python library to make API calls to our dev environment. But when I repointed to our prod environment which does have SSL enabled, the calls were constantly failing. It took a lot of investigation to finally track down the issue. Apparently, when SSL is not enabled, the endpoint you want to target is '.../gallery/api/v1'. When SSL is enabled, you want to target the endpoint '.../api/v1' (with no /gallery/). Hope this helps!

Re: Python library for Alteryx Gallery API

SeanAdams — Mon, 31 May 2021 06:30:27 GMT

The Gallery API would really benefit from an end-user accessible wrapper to drop into Alteryx

Thanks for sharing this @nick_simmons

Re: Python library for Alteryx Gallery API

NeilR — Mon, 18 Oct 2021 22:03:43 GMT

A lot of great Python code in the libraries mentioned in this thread, but, unless I missed it, none that explicitly supported the /admin/v1/{appId}/package/ endpoint (which is what I needed and thought I'd share below). JP used the requests_oauthlib package which really makes the code concise.

from requests_oauthlib import OAuth1 import requests base_url = 'https://[your_gallery_url]:[your_port]/api/admin/v1/' client_key = 'abc' client_secret = 'xyz' appId = '5d92671b826fd30b8453779e' appName = 'Advanced Join' url = base_url + appId +'/package/' queryoauth = OAuth1(client_key, client_secret, signature_type='query') request = requests.get(url, auth=queryoauth) with open(appName + '.yxzp', 'wb') as f: f.write(request.content)

Re: Python library for Alteryx Gallery API

saraA — Thu, 20 Jan 2022 12:07:47 GMT

How can I install PyRyx ?

Re: Python library for Alteryx Gallery API

ChristopherT — Tue, 19 Jul 2022 21:17:09 GMT

Hey Nick,

With OAuth1 being deprecated with 22.1 was wondering if you were planning to update any of these to accommodate the change for the new versions of Alteryx. Appreciate the information. Thank you!