8000 Merge branch 'development' into datasource_desc · trungluu1/server-client-python@0eed78f · GitHub
[go: up one dir, main page]
Skip to content

Commit 0eed78f

Browse files
jacalatajacalata
authored
Merge branch 'development' into datasource_desc
2 parents a0b9704 + 6e3e190 commit 0eed78f

File tree

188 files changed

+11660
-2045
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

188 files changed

+11660
-2045
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report or request for help
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**Versions**
14+
Details of your environment, including:
15+
- Tableau Server version (or note if using Tableau Online)
16+
- Python version
17+
- TSC library version
18+
19+
**To Reproduce**
20+
Steps to reproduce the behavior. Please include a code snippet where possible.
21+
22+
**Results**
23+
What are the results or error messages received?
24+
25+
**NOTE:** Be careful not to post user names, passwords, auth tokens or any other private or sensitive information.

‎.github/workflows/run-tests.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Python tests
2+
3+
on: [push]
4+
5+
jobs:
6+
build:
7+
strategy:
8+
fail-fast: false
9+
matrix:
10+
os: [ubuntu-latest, macos-latest, windows-latest]
11+
python-version: [3.6, 3.7, 3.8, 3.9, 3.10.0-rc.2]
12+
13+
runs-on: ${{ matrix.os }}
14+
15+
steps:
16+
- uses: actions/checkout@v2
17+
18+
- name: Set up Python ${{ matrix.python-version }} on ${{ matrix.os }}
19+
uses: actions/setup-python@v2
20+
with:
21+
python-version: ${{ matrix.python-version }}
22+
23+
- name: Install dependencies
24+
run: |
25+
python -m pip install --upgrade pip
26+
pip install -e .[test]
27+
pip install mypy
28+
29+
- name: Test with pytest
30+
run: |
31+
pytest test
32+
33+
- name: Run Mypy but allow failures
34+
run: |
35+
mypy --show-error-codes --disable-error-code misc tableauserverclient
36+
continue-on-error: true

‎.gitignore

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ target/
7676
# pyenv
7777
.python-version
7878

79+
# poetry
80+
poetry.lock
81+
pyproject.toml
82+
7983
# celery beat schedule file
8084
celerybeat-schedule
8185

@@ -92,7 +96,8 @@ ENV/
9296
# Rope project settings
9397
.ropeproject
9498

95-
99+
# VSCode project settings
100+
.vscode/
96101

97102
# macOS.gitignore from https://github.com/github/gitignore
98103
*.DS_Store

‎.travis.yml

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎CHANGELOG.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,74 @@
1+
## 0.16.0 (15 July 2021)
2+
* Documentation updates (#800, #818, #839, #842)
3+
* Fixed data alert repr in subscription item (#821)
4+
* Added support for Data Quality Warning (#836)
5+
* Added support for renaming datasources (#843)
6+
* Improved Datasource tests (#843)
7+
* Updated catalog obfuscation field (#844)
8+
* Fixed revision limit field in site_item.py file (#847)
9+
* Added the Missing content permission field- LockedToProjectWithoutNested (#856)
10+
11+
## 0.15.0 (16 Feb 2021)
12+
* Added support for python version 3.9 (#744)
13+
* Added support for 'Get View by ID' (#750)
14+
* Added docs and test data to MANIFEST.in file (#780)
15+
* Added owner_id property to ProjectItem (#784)
16+
* Added support for skipping connection check while publishing workbook (#791)
17+
* Added support for 'Update Subscription' (#794)
18+
* Added support for 'Get Groups for a User' (#799)
19+
* Improved debug logging by including put/post request contents (#743)
20+
* Improved local and active-directory group creation (#770)
21+
* Improved 'Update Group' to match server requests/responses (#772)
22+
* Improved SiteItem with new properties and functions (#777)
23+
* Improved SubscriptionItem with new properties (#794)
24+
* Improved the 'type' property of TaskItem to convert server response to enum (#796)
25+
* Improved repository to use Github Actions for running tests/linter (#798)
26+
* Fixed data_acceleration field causing error in workbook update payload (#741)
27+
28+
## 0.14.1 (9 Dec 2020)
29+
* Fixed filter query issue for server version below 2020.1 (#745)
30+
* Fixed large workbook/datasource publish issue (#757)
31+
32+
## 0.14.0 (6 Nov 2020)
33+
* Added django-style filtering and sorting (#615)
34+
* Added encoding tag-name before deleting (#687)
35+
* Added 'Execute' Capability to permissions (#700)
36+
* Added support for publishing workbook using file objects (#704)
37+
* Added new fields to datasource_item (#705)
38+
* Added all fields for users.get to get email and fullname (#713)
39+
* Added support publishing datasource using file objects (#714)
40+
* Improved request options by removing manual query param generation (#686)
41+
* Improved publish_workbook sample to take in site (#694)
42+
* Improved schedules.update() by removing constraint that required an interval (#711)
43+
* Fixed site update/create not checking booleans properly (#723)
44+
45+
## 0.13 (1 Sept 2020)
46+
* Added notes field to JobItem (#571)
47+
* Added webpage_url field to WorkbookItem (#661)
48+
* Added support for switching between sites (#655)
49+
* Added support for querying favorites for a user (#656)
50+
* Added support for Python 3.8 (#659)
51+
* Added support for Data Alerts (#667)
52+
* Added support for basic Extract operations - Create, Delete, en/re/decrypt for site (#672)
53+
* Added support for creating and querying Active Directory groups (#674)
54+
* Added support for asynchronously updating a group (#674)
55+
* Improved handling of invalid dates (#529)
56+
* Improved consistency of update_permission endpoints (#668)
57+
* Documentation updates (#658, #669, #670, #673, #683)
58+
59+
## 0.12.1 (22 July 2020)
60+
61+
* Fixed login.py sample to properly handle sitename (#652)
62+
63+
## 0.12 (10 July 2020)
64+
65+
* Added hidden_views parameter to workbook publish method (#614)
66+
* Added simple paging endpoint for GraphQL/Metadata API (#623)
67+
* Added endpoints to Metadata API for retrieving backfill/eventing status (#626)
68+
* Added maxage parameter to CSV and PDF export options (#635)
69+
* Added support for querying, adding, and deleting favorites (#638)
70+
* Added a sample for publishing datasources (#644)
71+
172
## 0.11 (1 May 2020)
273

374
* Added more fields to Data Acceleration config (#588)

‎CONTRIBUTORS.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,15 @@ The following people have contributed to this project to make it possible, and w
3636
* [Geraldine Zanolli](https://github.com/illonage)
3737
* [Jordan Woods](https://github.com/jorwoods)
3838
* [Reba Magier](https://github.com/rmagier1)
39+
* [Stephen Mitchell](https://github.com/scuml)
40+
* [absentmoose](https://github.com/absentmoose)
41+
* [Paul Vickers](https://github.com/paulvic)
42+
* [Madhura Selvarajan](https://github.com/maddy-at-leisure)
43+
* [Niklas Nevalainen](https://github.com/nnevalainen)
44+
* [Terrence Jones](https://github.com/tjones-commits)
45+
* [John Vandenberg](https://github.com/jayvdb)
46+
* [Lee Boynton](https://github.com/lboynton)
47+
* [annematronic](https://github.com/annematronic)
3948

4049
## Core Team
4150

@@ -48,3 +57,5 @@ The following people have contributed to this project to make it possible, and w
4857
* [Priya Reguraman](https://github.com/preguraman)
4958
* [Jac Fitzgerald](https://github.com/jacalata)
5059
* [Dan Zucker](https://github.com/dzucker-tab)
60+
* [Brian Cantoni](https://github.com/bcantoni)
61+
* [Ovini Nanayakkara](https://github.com/ovinis)

‎MANIFEST.in

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,22 @@ include versioneer.py
22
include tableauserverclient/_version.py
33
include LICENSE
44
include LICENSE.versioneer
5+
include README.md
6+
include CHANGELOG.md
7+
recursive-include docs *.md
8+
recursive-include samples *.py
9+
recursive-include samples *.txt
10+
recursive-include smoke *.py
11+
recursive-include test *.csv
12+
recursive-include test *.dict
13+
recursive-include test *.hyper
14+
recursive-include test *.json
15+
recursive-include test *.pdf
16+
recursive-include test *.png
17+
recursive-include test *.py
18+
recursive-include test *.tde
19+
recursive-include test *.tds
20+
recursive-include test *.tdsx
21+
recursive-include test *.twb
22+
recursive-include test *.twbx
23+
recursive-include test *.xml

‎README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# Tableau Server Client (Python)
2-
[![Tableau Supported](https://img.shields.io/badge/Support%20Level-Tableau%20Supported-53bd92.svg)](https://www.tableau.com/support-levels-it-and-developer-tools)
2+
3+
[![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)
34

45
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:
56

67
* Publish workbooks and data sources.
78
* Create users and groups.
89
* Query projects, sites, and more.
910

10-
This repository contains Python source code and sample files.
11+
This repository contains Python source code and sample files. Python versions 3.6 and up are supported.
1112

1213
For more information on installing and using TSC, see the documentation:
13-
1414
<https://tableau.github.io/server-client-python/docs/>
15+

‎contributing.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ a feature do not require the CLA.
1515

1616
## Issues and Feature Requests
1717

18-
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.
18+
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.
1919

2020
If you are submitting a bug report, please provide as much information as you can, including clear and concise repro steps, attaching any necessary
2121
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:
4848
## Fixes, Implementations, and Documentation
4949

5050
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
51-
creating a PR can be found in the [Development Guide](https://tableau.github.io/server-client-python/docs/dev-guide)
51+
creating a PR can be found in the [Development Guide](https://tableau.github.io/server-client-python/docs/dev-guide).
5252

5353
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
5454
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
5555
somewhere.
5656

57-
5857
## Getting Started
59-
> pip install versioneer
60-
> python setup.py build
61-
> python setup.py test
62-
>
63-
64-
### before committing
65-
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
66-
> pycodestyle tableauserverclient test samples
58+
59+
```shell
60+
pip install versioneer
61+
python setup.py build
62+
python setup.py test
63+
```
64+
65+
### Before Committing
66+
67+
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.
68+
69+
```shell
70+
# this will run the formatter without making changes
71+
black --line-length 120 tableauserverclient --check
72+
73+
# this will format the directory and code for you
74+
black --line-length 120 tableauserverclient
75+
```

‎publish.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
set -e
44

55
rm -rf dist
6-
python setup.py sdist
7-
python setup.py bdist_wheel
6+
python3 setup.py sdist
87
python3 setup.py bdist_wheel
98
twine upload dist/*

0 commit comments

Comments
 (0)
0