https://github.com/mhadi813/tableau_prep_publisher

The app executes tableau prep flow to refresh hyper file locally and/or publishes extract file to tableau server
https://github.com/mhadi813/tableau_prep_publisher

python tableau-hyper tableau-prep tableau-server-api

Last synced: about 2 months ago
JSON representation

The app executes tableau prep flow to refresh hyper file locally and/or publishes extract file to tableau server

• Host: GitHub
• URL: https://github.com/mhadi813/tableau_prep_publisher
• Owner: mhadi813
• Created: 2020-04-21T03:39:45.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-02-10T22:46:57.000Z (almost 2 years ago)
• Last Synced: 2023-03-04T13:07:52.692Z (almost 2 years ago)
• Topics: python, tableau-hyper, tableau-prep, tableau-server-api
• Language: Python
• Size: 27.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# tableau_prep_publisher

The app executes tableau prep flow to refresh extract.hyper file locally and/or publishes extract file to tableau server

Situations in which this app is useful:

  - you don't have access to tableau prep conductor or the server is running on different version

  - you develop tableau prep flow on mac OS and want to refresh the extract file with batch jobs running on windows machine

  - tableau server requires two factor authentication

  - or you want to use service account for publishing extracts to tableau server

  

The app uses Tableau Prep cli ``https://help.tableau.com/current/prep/en-us/prep_run_commandline.htm``  and Tableau Server Python Client ``https://tableau.github.io/server-client-python/docs/`` under the hood.

# set up:

1) create python virtual environment and install requirements

   ``conda update -n base -c defaults conda``

   ``conda create --name pytab``

   ``conda activate pytab``

   ``conda install pip``

   ``pip install -r requirements.txt``

2) modify the flow to output extract file on local machine. If the flow requires credentials for both input and out connections, keep them as is.

3) create batch or shell script to execute tableau_prep_publisher.py in the python virtual environment

    ``example batch file for Windows server``, publishes to default project in Overwirte mode

  

    ``call activate pytab``

    

    ``python tableau_prep_publisher.py -t "C:\Users\super_user\Desktop\tableau_prep_publisher\my_data_sources\my_test.tfl" -c "C:\Users\super_user\Desktop\tableau_prep_publisher\my_data_sources\credentials.json"``

    

    ``call conda deactivate ``

4) schedule batch job or shell script

# command line arguments:

python tableau_prep_publisher.py --help

### usage: python tableau_prep_publisher.py [-h] [-v --version] [-t --flow_path] [-c --credentails] [-e --hyper] [-m --mode] [-p --project] [-n --not_embed] [-l --logging]

### optional arguments:

  -h, --help           show this help message and exit

  

  -v , --version       Tableau Prep version, defaults to 2020.1

  

  -t , --flow_path     path of tableau prep flow.tfl file

  

  -c , --credentials   path of credential.json per tableau prep cli specification, must contain `outputConnections`                                  credentails for Tableau server for publishing

  

  -e , --hyper         extract.hyper file path or name for publishing to server. If output of tableau.prep is not in the same

                       folder as flow.tfl or multple hyper files are in the same folder, hyper_path must be explicitly                                supplied

                       

  -m , --mode          publish mode for extract.hyper. Use ``Overwrite``, ``CreateNew`` or ``Append`` values, defaults to

                       Overwrite

                       

  -p , --project       destination Project (folder) on tableau server for publishing extract.hyper, defaults to Default                              project

  

  -n, --not_embed      flag for not embeding credentials in datasource

  

  -l , --logging       logging level, defaults to INFO. use DEBUG, INFO, WARNING, ERROR, CRITICAL