Skip to content

Commit 805957e

Browse files
jacalatat8y8r-richmondRussell Hayjdomingu
authored
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]>
1 parent 58777f7 commit 805957e

36 files changed

+7901
-65
lines changed

‎.github/workflows/python-package.yml

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
2+
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
3+
4+
name: Python package
5+
6+
on:
7+
push:
8+
paths-ignore:
9+
- 'docs/**'
10+
pull_request:
11+
branches: '*'
12+
13+
jobs:
14+
build:
15+
16+
runs-on: ubuntu-latest
17+
strategy:
18+
fail-fast: false
19+
matrix:
20+
python-version: [3.7, 3.8, 3.9]
21+
22+
steps:
23+
- uses: actions/checkout@v2
24+
- name: Set up Python ${{ matrix.python-version }}
25+
uses: actions/setup-python@v2
26+
with:
27+
python-version: ${{ matrix.python-version }}
28+
- name: Install dependencies
29+
run: |
30+
python -m pip install --upgrade pip
31+
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
32+
- name: Test
33+
run: |
34+
python setup.py test
35+
36+
37+
lint:
38+
39+
runs-on: ubuntu-latest
40+
strategy:
41+
fail-fast: false
42+
matrix:
43+
python-version: [3.9]
44+
45+
steps:
46+
- uses: actions/checkout@v2
47+
- name: Set up Python ${{ matrix.python-version }}
48+
uses: actions/setup-python@v2
49+
with:
50+
python-version: ${{ matrix.python-version }}
51+
- name: Install dependencies
52+
run: |
53+
python -m pip install --upgrade pip
54+
python -m pip install pycodestyle
55+
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
56+
- name: Lint with pycodestyle
57+
run: |
58+
pycodestyle tableaudocumentapi test samples
59+

‎.travis.yml

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ language: python
22
cache: pip
33

44
python:
5+
56
- "3.6" # EOL 23 Dec 2021
67
- "3.7"
78
- "3.8"

‎CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11

2+
## 08 (October 2021)
3+
* See dashboards in a workbook
4+
* Add shapes property
5+
* Add custom sql
6+
* Drop python 2, add up through 3.9
7+
8+
29
## 07 (26 May 2021)
310
* Fix bug in xfile that overwrote the namespace name when saving a document
411

‎README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Document API
1212
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 :)
1313

1414
Features include:
15-
- Support for 9.X, and 10.X workbook and data source files
15+
- Support for 9.X, 10.X and 202x.x workbook and data source files
1616
- Including TDSX and TWBX files
1717
- Getting connection information from data sources and workbooks
1818
- Server Name
@@ -29,3 +29,5 @@ Features include:
2929
- Get all fields in use by certain sheets in a workbook
3030

3131
We don't yet support creating files from scratch, adding extracts into workbooks or data sources, or updating field information
32+
33+
As of 2021, this SDK no longer supports Python 2.

‎docs/_includes/docs_menu.html

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<div class="well docs-menu col-xs-12 col-sm-4 col-md-3">
2+
{% include search_form.html %}
23
<ul class="nav nav-list">
34
<li>
45
<a href="{{ site.baseurl }}/docs">Get Started</a>

‎docs/_includes/head.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
<link rel="stylesheet" href="{{ site.baseurl }}/css/main.css">
1212
<link rel="stylesheet" href="{{ site.baseurl }}/css/github-highlight.css">
1313

14-
<script src="https://code.jquery.com/jquery-2.2.4.min.js"></script>
14+
<script src="{{ site.baseurl }}/js/redirect-to-search.js"></script>
15+
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
1516
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script>
1617

1718
{% if jekyll.environment == "production" %}{% include analytics.html %}{% endif %}

‎docs/_includes/search_form.html

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<div class="search-container form-group has-feedback">
2+
<form id="docs-search">
3+
<input type="search" id="search-input" class="custom-search form-control" placeholder="Search the docs..." search-url="{{ site.baseurl}}/docs/search.html">
4+
<span class="glyphicon glyphicon-search form-control-feedback"></span>
5+
</form>
6+
</div>
7+

‎docs/_layouts/search.html

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
layout: search
3+
---
4+
5+
<!DOCTYPE html>
6+
<html>
7+
8+
<head>
9+
{% include head.html %}
10+
<script type="text/javascript">
11+
var search_blob = {
12+
{% for page in site.pages %}
13+
{% if page.indexed_by_search != false %}
14+
"{{ site.baseurl }}{{ page.url }}": {
15+
"title": {{ page.title | escape | jsonify }},
16+
"content": {{ page.content | remove_first: '* TOC' | replace_first:':toc',':class="blank"' | markdownify | strip_html | normalize_whitespace | jsonify }}
17+
}{% unless forloop.last %},{% endunless %}
18+
{% endif %}
19+
{% endfor %}
20+
};
21+
</script>
22+
23+
<script src="{{ site.baseurl }}/js/lunr.min.js"></script>
24+
<script src="{{ site.baseurl }}/js/search.js"></script>
25+
</head>
26+
27+
<body>
28+
<div class="container">
29+
{% include header.html %}
30+
{% include docs_menu.html %}
31+
32+
<div class="content .col-xs-12 .col-sm-8 .col-md-9">
33+
<h1 id="searchHeading"></h1>
34+
<br />
35+
<div id="searchResultsContainer">
36+
<p>Loading search results...</p>
37+
</div>
38+
39+
{% include footer.html %}
40+
</div>
41+
</div>
42+
</body>
43+
</html>

‎docs/docs/contributing.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,7 @@ anyone can add to an issue:
5151

5252
## Fixes, Implementations, and Documentation
5353

54-
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
55-
creating a PR can be found in the [github documentation](https://help.github.com/articles/creating-a-pull-request/)
54+
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)
5655

5756
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
5857
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

‎docs/docs/dev-guide.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,19 @@ layout: docs
1717
git clone http://github.com/<your_username>/document-api-python
1818
```
1919

20+
1. Check out the development branch
21+
22+
```shell
23+
git checkout development
24+
```
25+
2026
1. Run the tests to make sure everything is peachy:
2127

2228
```shell
2329
python setup.py test
2430
```
2531

26-
1. Set up the feature, fix, or documentation branch.
32+
1. Set up the feature, fix, or documentation branch.
2733

2834
It is recommended to use the format issue#-type-description (e.g. 13-fix-connection-bug) like so:
2935

@@ -60,7 +66,7 @@ layout: docs
6066
1. Make a PR as described [here](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the 'development' branch.
6167

6268
1. Wait for a review and address any feedback.
63-
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.
69+
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.
6470

6571
1. That's it! When the PR has received :rocket:'s from members of the core team they will merge the PR
6672

‎docs/docs/search.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Search
3+
layout: search
4+
---
5+

0 commit comments

Comments
 (0)