Merge branch 'development' into add-namespace-samples

Author: jacalata

.github/workflows/python-package.yml

@@ -0,0 +1,38 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python package
+
+on:
+  push:
+    paths-ignore:
+      - 'docs/**'
+  pull_request:
+    branches: '*'
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.7, 3.8, 3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install pycodestyle
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with pycodestyle
+      run: |
+        pycodestyle tableaudocumentapi test samples
+    - name: Test
+      run: |
+        python setup.py test

.travis.yml

@@ -2,11 +2,10 @@ language: python
 cache: pip
 
 python:
-  - "2.7"
   - "3.4"
   - "3.5"
   - "3.6"
-  - "pypy"
+  - "pypy3"
 # command to install dependencies
 install:
   - "pip install -e ."

README.md

@@ -7,10 +7,6 @@ For more information, see the documentation:
 
 <http://tableau.github.io/document-api-python>
 
-For more information, see the documentation:
-
-<http://tableau.github.io/document-api-python>
-
 Document API
 ---------------
 The Document API provides a supported way to programmatically make updates to Tableau workbook and data source files. If you've been making changes to these file types by directly updating the XML--that is, by XML hacking--this SDK is for you :)
@@ -33,3 +29,6 @@ Features include:
   - Get all fields in use by certain sheets in a workbook
 
 We don't yet support creating files from scratch, adding extracts into workbooks or data sources, or updating field information
+
+
+As of 2021, this SDK no longer supports Python 2.

docs/docs/contributing.md

@@ -51,7 +51,7 @@ anyone can add to an issue:
 
 ## Fixes, Implementations, and Documentation
 
-For all other things, please submit a PR that includes the fix, documentation, or new code that you are trying to contribute. More information on submitting a PR can be found in the [developer guide](dev-guide.md)
+For all other things, please submit a PR that includes the fix, documentation, or new code that you are trying to contribute.  More information on this can be found in our [developer guide](http://tableau.github.io/document-api-python/docs/dev-guide)
 
 If the feature is complex or has multiple solutions that could be equally appropriate approaches, it would be helpful to file an issue to discuss the
 design trade-offs of each solution before implementing, to allow us to collectively arrive at the best solution, which most likely exists in the middle

publish.sh

@@ -5,5 +5,4 @@ set -e
 rm -rf dist
 python setup.py sdist
 python setup.py bdist_wheel
-python3 setup.py bdist_wheel
 twine upload dist/*

setup.py

@@ -1,8 +1,5 @@
-try:
-    from setuptools import setup
-except ImportError:
-    from distutils.core import setup
-
+from setuptools import setup
+    
 setup(
     name='tableaudocumentapi',
     version='0.6',

tableaudocumentapi/connection.py

@@ -28,8 +28,7 @@ def __repr__(self):
 
     @classmethod
     def from_attributes(cls, server, dbname, username, dbclass, port=None, query_band=None,
-                        initial_sql=None, authentication='', schema='', service=''):
-
+                        initial_sql=None, authentication=''):
         """Creates a new connection that can be added into a Data Source.
         defaults to `''` which will be treated as 'prompt' by Tableau."""
 
@@ -38,8 +37,6 @@ def from_attributes(cls, server, dbname, username, dbclass, port=None, query_ban
         xml.server = server
         xml.dbname = dbname
         xml.username = username
-        xml.schema = schema
-        xml.service = service
         xml.dbclass = dbclass
         xml.port = port
         xml.query_band = query_band
@@ -211,43 +208,3 @@ def initial_sql(self, value):
                 pass
         else:
             self._connectionXML.set('one-time-sql', value)
-
-    @property
-    def schema(self):
-        """Database schema for the connection. Not the table name."""
-        return self._schema
-
-    @schema.setter
-    def schema(self, value):
-        """
-        Set the connection's schema property.
-
-        Args:
-            value:  New name of the database schema. String.
-
-        Returns:
-            Nothing.
-
-        """
-        self._schema = value
-        self._connectionXML.set('schema', value)
-
-    @property
-    def service(self):
-        """Database service for the connection. Not the table name."""
-        return self._service
-
-    @service.setter
-    def service(self, value):
-        """
-        Set the connection's service property.
-
-        Args:
-            value:  New name of the database service. String.
-
-        Returns:
-            Nothing.
-
-        """
-        self._service = value
-        self._connectionXML.set('service', value)

tableaudocumentapi/datasource.py

@@ -9,16 +9,6 @@
 from tableaudocumentapi.multilookup_dict import MultiLookupDict
 from tableaudocumentapi.xfile import xml_open
 
-########
-# This is needed in order to determine if something is a string or not.  It is necessary because
-# of differences between python2 (basestring) and python3 (str).  If python2 support is ever
-# dropped, remove this and change the basestring references below to str
-try:
-    basestring
-except NameError:  # pragma: no cover
-    basestring = str
-########
-
 _ColumnObjectReturnTuple = collections.namedtuple('_ColumnObjectReturnTupleType', ['id', 'object'])
 
 
@@ -38,7 +28,7 @@ class FieldDictionary(MultiLookupDict):
     def used_by_sheet(self, name):
         # If we pass in a string, no need to get complicated, just check to see if name is in
         # the field's list of worksheets
-        if isinstance(name, basestring):
+        if isinstance(name, str):
             return [x for x in self.values() if name in x.worksheets]
 
         # if we pass in a list, we need to check to see if any of the names in the list are in

tableaudocumentapi/xfile.py

@@ -5,10 +5,7 @@
 import zipfile
 import xml.etree.ElementTree as ET
 
-try:
-    from distutils2.version import NormalizedVersion as Version
-except ImportError:
-    from distutils.version import LooseVersion as Version
+from distutils.version import LooseVersion as Version
 
 MIN_SUPPORTED_VERSION = Version("9.0")
 
@@ -28,7 +25,7 @@ def xml_open(filename, expected_root=None):
     # Is the file a zip (.twbx or .tdsx)
     if zipfile.is_zipfile(filename):
         tree = get_xml_from_archive(filename)
-    else:   
+    else:
         _register_all_namespaces()
         tree = ET.parse(filename)
 
@@ -55,9 +52,11 @@ def temporary_directory(*args, **kwargs):
     finally:
         shutil.rmtree(d)
 
-def _register_all_namespaces():    
+
+def _register_all_namespaces():
     # TO DO: should look at the file to find namespaces, not hardcode this one
-    ET.register_namespace("user","http://www.tableausoftware.com/xml/user")
+    ET.register_namespace("user", "http://www.tableausoftware.com/xml/user")
+
 
 def find_file_in_zip(zip_file):
     '''Returns the twb/tds file from a Tableau packaged file format. Packaged
@@ -124,9 +123,9 @@ def save_into_archive(xml_tree, filename, new_filename=None):
 
 
 def _save_file(container_file, xml_tree, new_filename=None):
-    
-    _register_all_namespaces() # this shouldn't be necessary, should be done on open
- 
+
+    _register_all_namespaces()  # this shouldn't be necessary, should be done on open
+
     if new_filename is None:
         new_filename = container_file
 

test/assets/index.py

@@ -27,4 +27,3 @@
 TWBX_WITH_CACHE_FILES = os.path.join(TEST_DIR, 'Cache.twbx')
 
 COMPLEX_TWB = os.path.join(TEST_DIR, 'filtering.twb')
-