.md

.md

.md

active_flows

\

.md

\

.md

'

import prefect
import glob
import os

api_server = 'localhost:4200' #or set to whatever your GraphQL address/port is

client = prefect.Client(api_server=api_server)

#Pull all flows that are not archived, to get their flow_group_id 
active_flows = client.graphql(
				{
					'query': {
						  'flow(where:{archived:{ _lte: false }})': {
							'id'
							,'name'
							,'flow_group_id'
							,'archived'
						  }            
						}
				}
			)
			
#Iterate through active_flows and search folder for markdown files with the same name, write them to the flow_group using the flow_group_id
for i in active_flows['data']['flow']:
	flow_group_id = i['flow_group_id'] #id used for API call
	for j in glob.glob(r'.\{markdown_file}*'.format(markdown_file=i['name'])): #there's probably a better way to access this than with this for loop
		with open(j) as file:
			markdown = file.read()
			markdown = markdown.replace("\n"," \\n ") #the \n blows up the API call to write this, I found adding the escape \ fixed the problem
		client.graphql(
				{
					'mutation': {
						'''set_flow_group_description(input:{flow_group_id: "%s",description:"%s"})'''%(flow_group_id,markdown): {
					'success'
					}
					}
				}
		)
		print(j + ' written to Prefect server')


#I also wanted a way to check if there's any flow_groups missing documentation
#I post the results from this to a Google Chat room via a bot and webhook
missing_documentation = client.graphql(
				{
					'query': {
						'flow_group(where:{description:{_is_null:true}})': {
							'id'
							,'name'
							,'description'
						}
					}
				}
)

#make a list of all flow_group ids that came back with description=null
#could probably be tidied up with list comprehension
missing_id_ls = []
for i in missing_documentation['data']['flow_group']:
	missing_id_ls.append(i['id'])

#match up the ids with the names so its human-readable 
missing_name_ls = []
for i in active_flows['data']['flow']:
	if i['flow_group_id'] in missing_id_ls:
		missing_name_ls.append(i['name'])

if len(missing_name_ls) > 0:
	message = 'The following flow groups do not have documentation deployed: '+str(missing_name_ls)
	print(message)
	#my_external_package.post_to_gchat(webhook_url='gchat_webhook', message=message)
else: 
	print('No flows missing documentation!')