adding initial version of Document API

Includes setup.py along with example of replicating a workbook

Author: benlower

Document API/Examples/Replicate Workbook/Sample - Superstore.twb

@@ -0,0 +1,101 @@
+DBFriendlyName,Server,Database,User
+DB-001,SQL.SERVER.120,spdb-001,louisebrown
+DB-002,SQL.SERVER.127,spdb-002,brendadavis
+DB-003,SQL.SERVER.193,spdb-003,helensimmons
+DB-004,SQL.SERVER.126,spdb-004,lorirussell
+DB-005,SQL.SERVER.173,spdb-005,beverlysmith
+DB-006,SQL.SERVER.176,spdb-006,phyllisclark
+DB-007,SQL.SERVER.181,spdb-007,debramurphy
+DB-008,SQL.SERVER.191,spdb-008,jeffreywood
+DB-009,SQL.SERVER.174,spdb-009,richardramirez
+DB-010,SQL.SERVER.115,spdb-010,christinamiller
+DB-011,SQL.SERVER.176,spdb-011,larrywashington
+DB-012,SQL.SERVER.106,spdb-012,martinadams
+DB-013,SQL.SERVER.133,spdb-013,joycewilliams
+DB-014,SQL.SERVER.177,spdb-014,andrewbailey
+DB-015,SQL.SERVER.157,spdb-015,randybryant
+DB-016,SQL.SERVER.180,spdb-016,frankevans
+DB-017,SQL.SERVER.147,spdb-017,josephallen
+DB-018,SQL.SERVER.175,spdb-018,thomasbaker
+DB-019,SQL.SERVER.115,spdb-019,ericfoster
+DB-020,SQL.SERVER.155,spdb-020,janeking
+DB-021,SQL.SERVER.141,spdb-021,edwardmorris
+DB-022,SQL.SERVER.189,spdb-022,shawnjackson
+DB-023,SQL.SERVER.139,spdb-023,stephanieperez
+DB-024,SQL.SERVER.164,spdb-024,melissabarnes
+DB-025,SQL.SERVER.106,spdb-025,alangarcia
+DB-026,SQL.SERVER.199,spdb-026,juliahenderson
+DB-027,SQL.SERVER.104,spdb-027,jackmorgan
+DB-028,SQL.SERVER.103,spdb-028,catherineward
+DB-029,SQL.SERVER.159,spdb-029,chriswatson
+DB-030,SQL.SERVER.147,spdb-030,janetflores
+DB-031,SQL.SERVER.149,spdb-031,donaldlee
+DB-032,SQL.SERVER.167,spdb-032,jessicascott
+DB-033,SQL.SERVER.152,spdb-033,craigroberts
+DB-034,SQL.SERVER.104,spdb-034,laurahoward
+DB-035,SQL.SERVER.145,spdb-035,stevenreed
+DB-036,SQL.SERVER.143,spdb-036,bobbylong
+DB-037,SQL.SERVER.182,spdb-037,christopherprice
+DB-038,SQL.SERVER.124,spdb-038,clarenceanderson
+DB-039,SQL.SERVER.149,spdb-039,heatherpowell
+DB-040,SQL.SERVER.176,spdb-040,sarahmartin
+DB-041,SQL.SERVER.106,spdb-041,ashleyrivera
+DB-042,SQL.SERVER.121,spdb-042,billywright
+DB-043,SQL.SERVER.171,spdb-043,mariapeterson
+DB-044,SQL.SERVER.173,spdb-044,jimmybennett
+DB-045,SQL.SERVER.126,spdb-045,kevingonzalez
+DB-046,SQL.SERVER.110,spdb-046,anthonylopez
+DB-047,SQL.SERVER.134,spdb-047,tinacox
+DB-048,SQL.SERVER.136,spdb-048,annetorres
+DB-049,SQL.SERVER.176,spdb-049,carolyntaylor
+DB-050,SQL.SERVER.180,spdb-050,judywilson
+DB-051,SQL.SERVER.168,spdb-051,marthathomas
+DB-052,SQL.SERVER.121,spdb-052,sarakelly
+DB-053,SQL.SERVER.160,spdb-053,marysanchez
+DB-054,SQL.SERVER.191,spdb-054,kathleenalexander
+DB-055,SQL.SERVER.192,spdb-055,haroldhernandez
+DB-056,SQL.SERVER.185,spdb-056,kathrynjames
+DB-057,SQL.SERVER.180,spdb-057,scottmartinez
+DB-058,SQL.SERVER.154,spdb-058,gloriapatterson
+DB-059,SQL.SERVER.199,spdb-059,adamrodriguez
+DB-060,SQL.SERVER.194,spdb-060,francescooper
+DB-061,SQL.SERVER.135,spdb-061,samueldiaz
+DB-062,SQL.SERVER.127,spdb-062,denisemitchell
+DB-063,SQL.SERVER.178,spdb-063,royrogers
+DB-064,SQL.SERVER.197,spdb-064,theresalewis
+DB-065,SQL.SERVER.174,spdb-065,williamrichardson
+DB-066,SQL.SERVER.154,spdb-066,justinedwards
+DB-067,SQL.SERVER.108,spdb-067,katherinenelson
+DB-068,SQL.SERVER.186,spdb-068,wandajohnson
+DB-069,SQL.SERVER.177,spdb-069,lindahall
+DB-070,SQL.SERVER.138,spdb-070,tammywhite
+DB-071,SQL.SERVER.112,spdb-071,raymondgray
+DB-072,SQL.SERVER.117,spdb-072,nicholasharris
+DB-073,SQL.SERVER.196,spdb-073,shirleybutler
+DB-074,SQL.SERVER.113,spdb-074,benjaminjones
+DB-075,SQL.SERVER.174,spdb-075,janiceparker
+DB-076,SQL.SERVER.191,spdb-076,lisaphillips
+DB-077,SQL.SERVER.146,spdb-077,philipwalker
+DB-078,SQL.SERVER.116,spdb-078,margaretcollins
+DB-079,SQL.SERVER.148,spdb-079,dianestewart
+DB-080,SQL.SERVER.112,spdb-080,nancygonzales
+DB-081,SQL.SERVER.191,spdb-081,nicolegriffin
+DB-082,SQL.SERVER.136,spdb-082,mildredsanders
+DB-083,SQL.SERVER.162,spdb-083,cynthiacampbell
+DB-084,SQL.SERVER.147,spdb-084,pamelabell
+DB-085,SQL.SERVER.157,spdb-085,jacquelineross
+DB-086,SQL.SERVER.195,spdb-086,kimberlyhughes
+DB-087,SQL.SERVER.114,spdb-087,sandrayoung
+DB-088,SQL.SERVER.157,spdb-088,jennifergreen
+DB-089,SQL.SERVER.119,spdb-089,jasonperry
+DB-090,SQL.SERVER.135,spdb-090,rubycook
+DB-091,SQL.SERVER.185,spdb-091,bonniebrooks
+DB-092,SQL.SERVER.198,spdb-092,henrythompson
+DB-093,SQL.SERVER.164,spdb-093,louiscarter
+DB-094,SQL.SERVER.177,spdb-094,joanhill
+DB-095,SQL.SERVER.156,spdb-095,markrobinson
+DB-096,SQL.SERVER.120,spdb-096,andreaturner
+DB-097,SQL.SERVER.148,spdb-097,paulajenkins
+DB-098,SQL.SERVER.132,spdb-098,douglascoleman
+DB-099,SQL.SERVER.126,spdb-099,emilymoore
+DB-100,SQL.SERVER.143,spdb-100,charles

Document API/Examples/Replicate Workbook/databases.csv

@@ -0,0 +1,28 @@
+import csv              # so we can work with our database list (in a CSV file)
+import copy             # to make copies
+
+############################################################
+# Step 1)  Use Workbook object from the Document API
+############################################################
+from tableaudocumentapi import Workbook
+
+############################################################
+# Step 2)  Open the .twb we want to replicate
+############################################################
+sourceWB = Workbook('Sample - Superstore.twb')
+
+############################################################
+# Step 3)  Use a database list (in CSV), loop thru and
+#          create new .twb's with their settings
+############################################################
+with open('databases.csv') as csvfile:
+    next(csvfile)               # Skip the first line which is our CSV header row
+    databases = csv.reader(csvfile, delimiter=',', quotechar='"')
+    for row in databases:
+        newWB = copy.copy(sourceWB)
+        
+        # Set our unique values for this database
+        newWB.datasources[0].connection.server = row[1]         # Server
+        newWB.datasources[0].connection.dbname = row[2]         # Database
+        newWB.datasources[0].connection.username = row[3]       # User
+        newWB.save_as(row[0] + ' - Superstore' + '.twb')        # Save our newly created .twb with the new file name

Document API/Examples/Replicate Workbook/replicateWorkbook.py

@@ -0,0 +1,16 @@
+try:
+    from setuptools import setup
+except ImportError:
+    from distutils.core import setup
+
+setup(
+    name='tableaudocumentapi',
+    version='0.0.1',
+    summary='A Python module for working with Tableau files.',
+    author='Tableau Software',
+    author_email='github@tableau.com',
+    url='https://github.com/tableau/tableausdk-python',
+    py_modules=['tableaudocumentapi'],
+    license='MIT',
+    description='A Python module for working with Tableau files.'
+)

Document API/setup.py

@@ -0,0 +1,5 @@
+__version__ = '0.0.1'
+__VERSION__ = __version__
+from .connection import Connection
+from .datasource import Datasource
+from .workbook import Workbook

Document API/tableaudocumentapi/__init__.py

@@ -0,0 +1,92 @@
+###############################################################################
+#
+# Connection - A class for writing connections to Tableau files
+#
+###############################################################################
+class Connection(object):
+    """
+    A class for writing connections to Tableau files.
+
+    """
+
+    ###########################################################################
+    #
+    # Public API.
+    #
+    ###########################################################################
+
+    def __init__(self, connxml):
+        """
+        Constructor.
+
+        """
+        self._connectionXML = connxml
+        self._dbname = connxml.get('dbname')
+        self._server = connxml.get('server')
+        self._username = connxml.get('username')
+
+    ###########
+    # dbname
+    ###########
+    @property
+    def dbname(self):
+        return self._dbname
+
+    @dbname.setter
+    def dbname(self, value):
+        """
+        Set the connection's database name property.
+        
+        Args:
+            value:  New name of the database. String.
+            
+        Returns:
+            Nothing.
+            
+        """
+        self._dbname = value
+        self._connectionXML.set('dbname', value)
+
+    ###########
+    # server
+    ###########
+    @property
+    def server(self):
+        return self._server
+
+    @server.setter
+    def server(self, value):
+        """
+        Set the connection's server property.
+        
+        Args:
+            value:  New server. String.
+            
+        Returns:
+            Nothing.
+            
+        """
+        self._server = value
+        self._connectionXML.set('server', value)
+        
+    ###########
+    # username
+    ###########
+    @property
+    def username(self):
+        return self._username
+
+    @username.setter
+    def username(self, value):
+        """
+        Set the connection's username property.
+        
+        Args:
+            value:  New username value. String.
+            
+        Returns:
+            Nothing.
+            
+        """
+        self._username = value
+        self._connectionXML.set('username', value)

Document API/tableaudocumentapi/connection.py

@@ -0,0 +1,55 @@
+###############################################################################
+#
+# Datasource - A class for writing datasources to Tableau files
+#
+###############################################################################
+import xml.etree.ElementTree as ET
+from tableaudocumentapi import Connection
+
+class Datasource(object):
+    """
+    A class for writing datasources to Tableau files.
+
+    """
+
+    ###########################################################################
+    #
+    # Public API.
+    #
+    ###########################################################################
+    def __init__(self, dsxml):
+        """
+        Constructor.  Default is to create datasource from xml.
+
+        """
+        self._datasourceXML = dsxml
+        self._name = self._datasourceXML.get('name')
+        self._version = self._datasourceXML.get('version')
+        self._connection = Connection(self._datasourceXML.find('connection'))
+    
+    @classmethod
+    def from_file(cls, filename):
+        "Initialize datasource from file (.tds)"
+        dsxml = ET.parse(filename).getroot()
+        return cls(dsxml)
+        
+    ###########
+    # name
+    ###########
+    @property
+    def name(self):
+        return self._name
+        
+    ###########
+    # version
+    ###########
+    @property
+    def version(self):
+        return self._version
+
+    ###########
+    # connection
+    ###########
+    @property
+    def connection(self):
+        return self._connection