{"id":21298059,"url":"https://github.com/memiiso/pytableau","last_synced_at":"2025-07-11T18:32:40.993Z","repository":{"id":43241240,"uuid":"234395064","full_name":"memiiso/pytableau","owner":"memiiso","description":"pytableau, schedule tableau resports","archived":true,"fork":false,"pushed_at":"2023-10-04T00:57:17.000Z","size":50,"stargazers_count":8,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T13:47:10.321Z","etag":null,"topics":["datasources","pdf","reporting","scheduling-reports","tableau","workbooks"],"latest_commit_sha":null,"homepage":"","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/memiiso.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}},"created_at":"2020-01-16T19:26:36.000Z","updated_at":"2024-07-09T14:41:55.000Z","dependencies_parsed_at":"2023-01-30T00:31:09.173Z","dependency_job_id":null,"html_url":"https://github.com/memiiso/pytableau","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/memiiso/pytableau","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/memiiso%2Fpytableau","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/memiiso%2Fpytableau/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/memiiso%2Fpytableau/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/memiiso%2Fpytableau/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/memiiso","download_url":"https://codeload.github.com/memiiso/pytableau/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/memiiso%2Fpytableau/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264870657,"owners_count":23676285,"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":["datasources","pdf","reporting","scheduling-reports","tableau","workbooks"],"created_at":"2024-11-21T14:44:08.222Z","updated_at":"2025-07-11T18:32:40.657Z","avatar_url":"https://github.com/memiiso.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Python package](https://github.com/memiiso/pytableau/workflows/Python%20package/badge.svg)\n\nDistribute Tableu reports using workbook tags. Using any of csv, pdf, pgn export formats\nInteract with Tableu server, Download tableu content, triger datasource/extract refresh task\n\n# Installation\n```\npip install https://github.com/memiiso/pytableau/archive/master.zip --upgrade --user\n```\n\n# PyTableau\n\nPython wrapper for tableau server api. \nTableau class to interact with tableau server and server content\n\n- download_all_datasources\n- download_all_workbooks\n- export_all_datasource_fields_to_csv\n- export_all_workbook_fields_to_csv\n- download_workbook_pdf\n- download_workbook_png\n- download_workbook_csv\n- refresh_extracts\n\n# PyTableauReportScheduler\ntableau class to emailing reports as pdf using workbook tags\n\nforexample a workbook with following tags \n\n- sent to user1, user2 every day,\n- sent to  user3 Weekly on Mondays,\n- sent to user4, user2 at the first day of month every month.\n\n```\n'scheduledReport'\n,'Daily:to:user1@mail.com','Daily:cc:user2@mail.com'\n,'Weekly1:to:user3@mail.com'\n,'Monthly1:to:user4@mail.com','Monthly1:cc:user2@mail.com'\n```\n\na workbook with following tags sent\n- Weekly every Wednesday\n- monthly every 16th day of month\n\n```\n'scheduledReport'\n,'Weekly3:to:user3@mail.com'\n,'Monthly16:to:user4@mail.com','Monthly1:cc:user2@mail.com'\n```\n\n#### Schedule tags\nDaily = send every day\n\nWeekly* = * is weekday number(1...7) sends the report at given weekday\n\nMonthly* = * is month day number(1...31) sends the report at given month day\n\n## PyTableau Examples\n\n#### Init \n\n```python\nimport os\nimport smtplib\nfrom pathlib import Path\nfrom pytableau import PyTableau, PyTableauReportScheduler\nfrom urllib.parse import quote_plus\n\nmyTableau = PyTableau(server_address='http_tableau_server',\n      username='mytableauuser@mail.com',\n      password='mypassword',\n      site_id='Default'\n      )\n```\n\n## Refreshing Datasources\n```python\ndatasource_list = ['my Datasource1', 'my Datasource2', \"Datasource3\"]\nmyTableau.refresh_extracts(datasource_names=datasource_list, synchronous=True)\n```\n\n## Downloading All Server Workbooks, Datasources\n```python\ndownload_dir = \"/tmp/test_download_all_datasources\"\nPath(download_dir).mkdir(parents=True, exist_ok=True)\nmyTableau.download_all_workbooks(download_dir)\n```\n\n## Querying Server Workbooks, Datasources\n```python\ntag='dailyKpi'\nwbs  = myTableau.get_workbooks_by_tag(tag=tag)\nprint(\"Found %s Workbook with tag:%s\" % (str(len(wbs)), tag))\nwb  = myTableau.get_workbook_by_name(name='XYZ KPI REPORT', project_name='FINANCETEAM', tag='XYZKPI')\nprint(wb.name)\nprint(wb.updated_at)\nwb  = myTableau.get_workbook_by_name(name='XYZ REPORT', project_name='XYZ TEAM')\nprint(wb.name)\n```\n\n## Exporting Workbook to PDF\n```python\n# find the workbook\nwb  = myTableau.get_workbook_by_name(name='XYZ DASHBOARD', project_name='PROJECT_NAME')\n# export it to PDF\nmyTableau.download_workbook_pdf(workbook=wb, dest_dir=\"/tmp/somedir/\")\n```\n\n\n## PyTableauReportScheduler Examples\n\n#### Init \n```python\nimport os\nimport smtplib\nfrom pathlib import Path\nfrom pytableau import PyTableau, PyTableauReportScheduler\nfrom urllib.parse import quote_plus\n\nmyTableau = PyTableau(server_address='http_tableau_server',\n      username='mytableauuser@mail.com',\n      password='mypassword',\n      site_id='Default'\n      )\n\nmysmtp = smtplib.SMTP_SSL('smtp.gmail.com', 465)\nmysmtp.ehlo()\nmysmtp.login('myemail@mail.com', 'mypassword')\n\n# email all the reports with tag : scheduledReport\nmyTabScheduler= PyTableauReportScheduler(tableau=myTableau,smtp_server=mysmtp,schedule_tag=\"scheduledReport\")\n```\n\n\n## Emailing Reports\n```python\ndatafilters = dict()\ndatafilters[\"Report Year\"]=\"2019,2020\"\ndatafilters[\"Country\"]=\"US\"\n# send reports daily, weekly, monthly.\nmyTabScheduler.send_scheduled_reports(send_from='senderemail@mail.com', data_filters=datafilters)\n\n# send weekly Monday reports.\nmyTabScheduler.send_schedule(send_from='senderemail@mail.com', schedule='Wekkly1',data_filters=datafilters)\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmemiiso%2Fpytableau","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmemiiso%2Fpytableau","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmemiiso%2Fpytableau/lists"}