Development branch for v0.8 (#203)

## 08 (October 2021) * See dashboards in a workbook * Add shapes property * Add custom sql * Drop python 2, add up through 3.9 Co-authored-by: Tyler Doyle <[email protected]> Co-authored-by: r-richmond <[email protected]> Co-authored-by: Russell Hay <[email protected]> Co-authored-by: Jared Dominguez <[email protected]> Co-authored-by: Kernpunkt Analytics <[email protected]> Co-authored-by: doulam <[email protected]> Co-authored-by: Kevin Glinski <[email protected]> Co-authored-by: Russell Hay <[email protected]> Co-authored-by: Dave Hagen <[email protected]> Co-authored-by: martin dertz <[email protected]> Co-authored-by: dev-mkc19 <[email protected]> Co-authored-by: Jared Dominguez <[email protected]> Co-authored-by: Ben Lower <[email protected]> Co-authored-by: Patrick Carlson <[email protected]> Co-authored-by: Graeme Britz <[email protected]> Co-authored-by: Jac Fitzgerald <[email protected]>
tableau · Oct 16, 2021 · 805957e · 805957e
1 parent 58777f7
commit 805957e
Show file tree

Hide file tree

Showing 36 changed files with 7,901 additions and 65 deletions.
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -0,0 +1,59 @@
+# 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
+        if [ -f  requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Test  
+      run: |
+        python setup.py test
+  
+
+  lint:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+         python-version: [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
+  
diff --git a/.travis.yml b/.travis.yml
@@ -2,6 +2,7 @@ language: python
 cache: pip
 
 python:
+
   - "3.6" # EOL 23 Dec 2021
   - "3.7"
   - "3.8"

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,11 @@
 
+## 08 (October 2021)
+* See dashboards in a workbook
+* Add shapes property
+* Add custom sql
+* Drop python 2, add up through 3.9
+
+
 ## 07 (26 May 2021)
 * Fix bug in xfile that overwrote the namespace name when saving a document
 

diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ 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 :)
 
 Features include:
-- Support for 9.X, and 10.X workbook and data source files
+- Support for 9.X, 10.X and 202x.x workbook and data source files
   - Including TDSX and TWBX files
 - Getting connection information from data sources and workbooks
   - Server Name
@@ -29,3 +29,5 @@ 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.
diff --git a/docs/_includes/docs_menu.html b/docs/_includes/docs_menu.html
@@ -1,4 +1,5 @@
 <div class="well docs-menu col-xs-12 col-sm-4 col-md-3">
+    {% include search_form.html %}
     <ul class="nav nav-list">
         <li>
             <a href="{{ site.baseurl }}/docs">Get Started</a>

diff --git a/docs/_includes/head.html b/docs/_includes/head.html
@@ -11,7 +11,8 @@
   <link rel="stylesheet" href="{{ site.baseurl }}/css/main.css">
   <link rel="stylesheet" href="{{ site.baseurl }}/css/github-highlight.css">
 
-  <script src="https://code.jquery.com/jquery-2.2.4.min.js"></script>
+  <script src="{{ site.baseurl }}/js/redirect-to-search.js"></script>
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
   <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script>
 
 {% if jekyll.environment == "production" %}{% include analytics.html %}{% endif %}
diff --git a/docs/_includes/search_form.html b/docs/_includes/search_form.html
@@ -0,0 +1,7 @@
+<div class="search-container form-group has-feedback">
+    <form id="docs-search">
+        <input type="search" id="search-input" class="custom-search form-control" placeholder="Search the docs..." search-url="{{ site.baseurl}}/docs/search.html">
+        <span class="glyphicon glyphicon-search form-control-feedback"></span>
+    </form>
+</div>
+
diff --git a/docs/_layouts/search.html b/docs/_layouts/search.html
@@ -0,0 +1,43 @@
+---
+layout: search
+---
+
+<!DOCTYPE html>
+<html>
+
+<head>
+    {% include head.html %}
+	<script type="text/javascript">
+        var search_blob = {
+		{% for page in site.pages %}
+            {% if page.indexed_by_search != false %}
+                "{{ site.baseurl }}{{ page.url }}": {
+                    "title": {{ page.title | escape | jsonify }},
+                    "content": {{ page.content | remove_first: '* TOC' | replace_first:':toc',':class="blank"' | markdownify | strip_html | normalize_whitespace | jsonify }}
+                }{% unless forloop.last %},{% endunless %}
+            {% endif %}
+		{% endfor %}
+		};
+	</script>
+
+    <script src="{{ site.baseurl }}/js/lunr.min.js"></script>
+    <script src="{{ site.baseurl }}/js/search.js"></script>
+</head>
+
+<body>
+    <div class="container">
+        {% include header.html %}
+        {% include docs_menu.html %}
+
+        <div class="content .col-xs-12 .col-sm-8 .col-md-9">
+            <h1 id="searchHeading"></h1>
+            <br />
+            <div id="searchResultsContainer">
+                <p>Loading search results...</p>
+            </div>
+
+            {% include footer.html %}
+        </div>
+    </div>
+</body>
+</html>
diff --git a/docs/docs/contributing.md b/docs/docs/contributing.md
@@ -51,8 +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
-creating a PR can be found in the [github documentation](https://help.github.com/articles/creating-a-pull-request/)
+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

diff --git a/docs/docs/dev-guide.md b/docs/docs/dev-guide.md
@@ -17,13 +17,19 @@ layout: docs
    git clone http://github.com/<your_username>/document-api-python
    ```
 
+1. Check out the development branch
+
+   ```shell
+   git checkout development
+   ```
+
 1. Run the tests to make sure everything is peachy:
 
    ```shell
    python setup.py test
    ```
 
-1. Set up the feature, fix, or documentation branch.
+1. Set up the feature, fix, or documentation branch. 
 
    It is recommended to use the format issue#-type-description (e.g. 13-fix-connection-bug) like so:
 
@@ -60,7 +66,7 @@ layout: docs
 1. Make a PR as described [here](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the 'development' branch.
 
 1. Wait for a review and address any feedback.
-   While we try and stay on top of all issues and PRs it might take a few days for someone to respond. Politely pinging the PR after a few days with no response is OK, we'll try and respond with a timeline as soon as we are able.
+   While we try and stay on top of all issues and PRs, this isn't under active development so it might take a while for someone to respond. Politely pinging the PR after a few days with no response is OK, we'll try and respond with a timeline as soon as we are able.
 
 1. That's it! When the PR has received :rocket:'s from members of the core team they will merge the PR
 

diff --git a/docs/docs/search.md b/docs/docs/search.md
@@ -0,0 +1,5 @@
+---
+title: Search
+layout: search
+---
+
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,7 @@ language: python @@
     cache: pip
     python:
       - "3.6" # EOL 23 Dec 2021
       - "3.7"
       - "3.8"
@@ Expand Down @@