Merge branch 'development' into datasource_desc

Author: jacalata

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Create a bug report or request for help
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Versions**
+Details of your environment, including:
+ - Tableau Server version (or note if using Tableau Online)
+ - Python version
+ - TSC library version
+
+**To Reproduce**
+Steps to reproduce the behavior. Please include a code snippet where possible.
+
+**Results**
+What are the results or error messages received?
+
+**NOTE:** Be careful not to post user names, passwords, auth tokens or any other private or sensitive information.

.github/workflows/run-tests.yml

@@ -0,0 +1,36 @@
+name: Python tests
+
+on: [push]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: [3.6, 3.7, 3.8, 3.9, 3.10.0-rc.2]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python ${{ matrix.python-version }} on ${{ matrix.os }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[test]
+        pip install mypy
+
+    - name: Test with pytest
+      run: |
+        pytest test
+
+    - name: Run Mypy but allow failures
+      run: |
+        mypy --show-error-codes --disable-error-code misc tableauserverclient
+      continue-on-error: true

.gitignore

@@ -76,6 +76,10 @@ target/
 # pyenv
 .python-version
 
+# poetry
+poetry.lock
+pyproject.toml
+
 # celery beat schedule file
 celerybeat-schedule
 
@@ -92,7 +96,8 @@ ENV/
 # Rope project settings
 .ropeproject
 
-
+# VSCode project settings
+.vscode/
 
 # macOS.gitignore from https://github.com/github/gitignore
 *.DS_Store

.travis.yml

@@ -1,3 +1,74 @@
+## 0.16.0 (15 July 2021)
+* Documentation updates (#800, #818, #839, #842)
+* Fixed data alert repr in subscription item (#821)
+* Added support for Data Quality Warning (#836)
+* Added support for renaming datasources (#843)
+* Improved Datasource tests (#843)
+* Updated catalog obfuscation field (#844)
+* Fixed revision limit field in site_item.py file (#847)
+* Added the Missing content permission field- LockedToProjectWithoutNested (#856)
+
+## 0.15.0 (16 Feb 2021)
+* Added support for python version 3.9 (#744)
+* Added support for 'Get View by ID' (#750)
+* Added docs and test data to MANIFEST.in file (#780)
+* Added owner_id property to ProjectItem (#784)
+* Added support for skipping connection check while publishing workbook (#791)
+* Added support for 'Update Subscription' (#794)
+* Added support for 'Get Groups for a User' (#799)
+* Improved debug logging by including put/post request contents (#743)
+* Improved local and active-directory group creation (#770)
+* Improved 'Update Group' to match server requests/responses (#772)
+* Improved SiteItem with new properties and functions (#777)
+* Improved SubscriptionItem with new properties (#794)
+* Improved the 'type' property of TaskItem to convert server response to enum (#796)
+* Improved repository to use Github Actions for running tests/linter (#798)
+* Fixed data_acceleration field causing error in workbook update payload (#741)
+
+## 0.14.1 (9 Dec 2020)
+* Fixed filter query issue for server version below 2020.1 (#745)
+* Fixed large workbook/datasource publish issue (#757)
+
+## 0.14.0 (6 Nov 2020)
+* Added django-style filtering and sorting (#615)
+* Added encoding tag-name before deleting (#687)
+* Added 'Execute' Capability to permissions (#700)
+* Added support for publishing workbook using file objects (#704)
+* Added new fields to datasource_item (#705)
+* Added all fields for users.get to get email and fullname (#713)
+* Added support publishing datasource using file objects (#714)
+* Improved request options by removing manual query param generation (#686)
+* Improved publish_workbook sample to take in site (#694)
+* Improved schedules.update() by removing constraint that required an interval (#711)
+* Fixed site update/create not checking booleans properly (#723)
+
+## 0.13 (1 Sept 2020)
+* Added notes field to JobItem (#571)
+* Added webpage_url field to WorkbookItem (#661)
+* Added support for switching between sites (#655)
+* Added support for querying favorites for a user (#656)
+* Added support for Python 3.8 (#659)
+* Added support for Data Alerts (#667)
+* Added support for basic Extract operations - Create, Delete, en/re/decrypt for site (#672)
+* Added support for creating and querying Active Directory groups (#674)
+* Added support for asynchronously updating a group (#674)
+* Improved handling of invalid dates (#529)
+* Improved consistency of update_permission endpoints (#668)
+* Documentation updates (#658, #669, #670, #673, #683)
+
+## 0.12.1 (22 July 2020)
+
+* Fixed login.py sample to properly handle sitename (#652)
+
+## 0.12 (10 July 2020)
+
+* Added hidden_views parameter to workbook publish method (#614)
+* Added simple paging endpoint for GraphQL/Metadata API (#623)
+* Added endpoints to Metadata API for retrieving backfill/eventing status (#626)
+* Added maxage parameter to CSV and PDF export options (#635)
+* Added support for querying, adding, and deleting favorites (#638)
+* Added a sample for publishing datasources (#644)
+
 ## 0.11 (1 May 2020)
 
 * Added more fields to Data Acceleration config (#588)

CHANGELOG.md

@@ -36,6 +36,15 @@ The following people have contributed to this project to make it possible, and w
 * [Geraldine Zanolli](https://github.com/illonage)
 * [Jordan Woods](https://github.com/jorwoods)
 * [Reba Magier](https://github.com/rmagier1)
+* [Stephen Mitchell](https://github.com/scuml)
+* [absentmoose](https://github.com/absentmoose)
+* [Paul Vickers](https://github.com/paulvic)
+* [Madhura Selvarajan](https://github.com/maddy-at-leisure)
+* [Niklas Nevalainen](https://github.com/nnevalainen)
+* [Terrence Jones](https://github.com/tjones-commits)
+* [John Vandenberg](https://github.com/jayvdb)
+* [Lee Boynton](https://github.com/lboynton)
+* [annematronic](https://github.com/annematronic)
 
 ## Core Team
 
@@ -48,3 +57,5 @@ The following people have contributed to this project to make it possible, and w
 * [Priya Reguraman](https://github.com/preguraman)
 * [Jac Fitzgerald](https://github.com/jacalata)
 * [Dan Zucker](https://github.com/dzucker-tab)
+* [Brian Cantoni](https://github.com/bcantoni)
+* [Ovini Nanayakkara](https://github.com/ovinis)

CONTRIBUTORS.md

@@ -2,3 +2,22 @@ include versioneer.py
 include tableauserverclient/_version.py
 include LICENSE
 include LICENSE.versioneer
+include README.md
+include CHANGELOG.md
+recursive-include docs *.md
+recursive-include samples *.py
+recursive-include samples *.txt
+recursive-include smoke *.py
+recursive-include test *.csv
+recursive-include test *.dict
+recursive-include test *.hyper
+recursive-include test *.json
+recursive-include test *.pdf
+recursive-include test *.png
+recursive-include test *.py
+recursive-include test *.tde
+recursive-include test *.tds
+recursive-include test *.tdsx
+recursive-include test *.twb
+recursive-include test *.twbx
+recursive-include test *.xml

MANIFEST.in

@@ -1,14 +1,15 @@
 # Tableau Server Client (Python)
-[![Tableau Supported](https://img.shields.io/badge/Support%20Level-Tableau%20Supported-53bd92.svg)](https://www.tableau.com/support-levels-it-and-developer-tools)
+
+[![Tableau Supported](https://img.shields.io/badge/Support%20Level-Tableau%20Supported-53bd92.svg)](https://www.tableau.com/support-levels-it-and-developer-tools) [![Build Status](https://github.com/tableau/server-client-python/actions/workflows/run-tests.yml/badge.svg)](https://github.com/tableau/server-client-python/actions)
 
 Use the Tableau Server Client (TSC) library to increase your productivity as you interact with the Tableau Server REST API. With the TSC library you can do almost everything that you can do with the REST API, including:
 
 * Publish workbooks and data sources.
 * Create users and groups.
 * Query projects, sites, and more.
 
-This repository contains Python source code and sample files.
+This repository contains Python source code and sample files. Python versions 3.6 and up are supported.
 
 For more information on installing and using TSC, see the documentation:
-
 <https://tableau.github.io/server-client-python/docs/>
+ 

README.md

@@ -15,7 +15,7 @@ a feature do not require the CLA.
 
 ## Issues and Feature Requests
 
-To submit an issue/bug report, or to request a feature, please submit a [github issue](https://github.com/tableau/server-client-python/issues) to the repo.
+To submit an issue/bug report, or to request a feature, please submit a [GitHub issue](https://github.com/tableau/server-client-python/issues) to the repo.
 
 If you are submitting a bug report, please provide as much information as you can, including clear and concise repro steps, attaching any necessary
 files to assist in the repro.  **Be sure to scrub the files of any potentially sensitive information.  Issues are public.**
@@ -48,19 +48,28 @@ 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 [Development Guide](https://tableau.github.io/server-client-python/docs/dev-guide)
+creating a PR can be found in the [Development Guide](https://tableau.github.io/server-client-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
 somewhere.
 
-
 ## Getting Started
-> pip install versioneer
-> python setup.py build
-> python setup.py test
->
-
-### before committing
-Our CI runs include a python lint run, so you should run this locally and fix complaints before committing as this will fail your checkin
-> pycodestyle tableauserverclient test samples
+
+```shell
+pip install versioneer
+python setup.py build
+python setup.py test
+```
+
+### Before Committing
+
+Our CI runs include a Python lint run, so you should run this locally and fix complaints before committing as this will fail your checkin.
+
+```shell
+# this will run the formatter without making changes
+black --line-length 120 tableauserverclient --check
+
+# this will format the directory and code for you
+black --line-length 120 tableauserverclient
+```

contributing.md

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