diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml index 9c208c4..d732afc 100644 --- a/.github/workflows/publish-pypi.yml +++ b/.github/workflows/publish-pypi.yml @@ -1,6 +1,5 @@ name: Publish to PyPi - on: workflow_dispatch: push: @@ -11,24 +10,23 @@ jobs: name: Build dist files for PyPi runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 with: fetch-depth: 0 - - uses: actions/setup-python@v1 + - uses: actions/setup-python@v4 with: - python-version: 3.8 + python-version: 3.13 - name: Build dist files run: > python -m pip install --upgrade pip && pip install -e .[build] && python setup.py build && python setup.py sdist --formats=gztar - name: Publish distribution 📦 to Test PyPI - uses: pypa/gh-action-pypi-publish@release/v1 # license BSD-2 + uses: pypa/gh-action-pypi-publish@release/v1 # license BSD-2 with: password: ${{ secrets.TEST_PYPI_API_TOKEN }} repository_url: https://test.pypi.org/legacy/ - name: Publish distribution 📦 to PyPI - uses: pypa/gh-action-pypi-publish@release/v1 # license BSD-2 + uses: pypa/gh-action-pypi-publish@release/v1 # license BSD-2 with: password: ${{ secrets.PYPI_API_TOKEN }} - diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml index 4bd171f..c99b1e0 100644 --- a/.github/workflows/python-package.yml +++ b/.github/workflows/python-package.yml @@ -6,54 +6,50 @@ name: Python package on: push: paths-ignore: - - 'docs/**' + - "docs/**" pull_request: - branches: '*' + branches: "*" jobs: build: - runs-on: ubuntu-latest strategy: fail-fast: false matrix: - python-version: [3.7, 3.8, 3.9, '3.10'] + python-version: ["3.10", "3.11", "3.12", "3.13"] 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 - - + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + 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 -m unittest discover -v + lint: - runs-on: ubuntu-latest strategy: fail-fast: false matrix: - python-version: [3.9] + python-version: [3.13] 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 - + - 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/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..10fb2b9 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,2 @@ +#ECCN:Open Source +#GUSINFO:Open Source,Open Source Workflow diff --git a/README.md b/README.md index 3ae1b5f..beb0263 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,11 @@ # document-api-python -[![Tableau Supported](https://img.shields.io/badge/Support%20Level-Tableau%20Supported-53bd92.svg)](https://www.tableau.com/support-levels-it-and-developer-tools) +[![As-Is](https://img.shields.io/badge/Support%20Level-As--Is-e8762c.svg)](https://www.tableau.com/support-levels-it-and-developer-tools) -This repo contains Python source and example files for the Tableau Document API. - -For more information, see the documentation: - - 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 :) +This repo contains Python source and example files for the Tableau Document API. +The Document API provides a useful but *unsupported* 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 :) Get help from other users on the [Tableau Community Forums](https://community.tableau.com/s/topic/0TO4T000000SF3sWAG/document-api). Features include: - Support for TWB, TWBX, TDE and TDSX files starting roughly back to Tableau 9.x @@ -27,8 +23,9 @@ Features include: - Get all fields in a data source - Get all fields in use by certain sheets in a workbook +- It *doesn't* 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. + For Hyper files, take a look at the [Tableau Hyper API](https://help.tableau.com/current/api/hyper_api/en-us/index.html). -We don't support creating files from scratch, adding extracts into workbooks or data sources, or updating field information +For more information, see the [Document API documentation](https://tableau.github.io/document-api-python) -As of 2021, this SDK no longer supports Python 2. diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html index 6bfb1db..1b50f51 100644 --- a/docs/_includes/footer.html +++ b/docs/_includes/footer.html @@ -1,9 +1,19 @@ +
+ + \ No newline at end of file diff --git a/docs/_includes/head.html b/docs/_includes/head.html index 47d9f92..858a412 100644 --- a/docs/_includes/head.html +++ b/docs/_includes/head.html @@ -11,6 +11,14 @@ + + + + + + diff --git a/docs/css/main.css b/docs/css/main.css index f9a61e9..53a6ee3 100644 --- a/docs/css/main.css +++ b/docs/css/main.css @@ -278,3 +278,40 @@ html { word-spacing: 8px; padding-right: 8px; } + +.copyRight { + font-size: 12px; + } + + .footer-links { + display: flex; + justify-content: center; + list-style: none; + padding: 0; + flex-wrap: wrap; + } + + .footer-links li { + margin: 0 15px; + } + + .footer-links a { + text-decoration: none; + transition: color 0.3s; + font-size: 12px; + } + + .footer-links a:hover { + text-decoration: underline; + } + + /* One Trust Cookie Manager + -------------------- */ + #ot-pc-content, .ot-title-cntr, .ot-pc-footer { + font-size: 1.6rem; + } + + #ot-pc-footer { + font-size: 1.4rem; + } + diff --git a/docs/docs/api-ref.md b/docs/docs/api-ref.md index e6491f2..365634a 100644 --- a/docs/docs/api-ref.md +++ b/docs/docs/api-ref.md @@ -40,6 +40,8 @@ Saves any changes to the workbook to a new file specified by the `new_file` para `self.shapes` Returns a list of strings with the names of shapes found in the workbook. +`self.dashboards:` Returns a list of strings with the names of the dashboards found in the workbook + ## Datasources ```python class Datasource(dsxml, filename=None) @@ -66,7 +68,7 @@ A class representing Tableau Data Sources, embedded in workbook files or in TDS `self.name` Returns string with the name of datasource. -`self.version` Returns string of daatasource's version. +`self.version` Returns string of datasource's version. `self.caption` Returns string of user defined name of datasource if exists. diff --git a/docs/index.md b/docs/index.md index 9c54d74..cfd15c7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,7 +13,7 @@ layout: home # Document API Overview This repo contains Python source and example files for the Tableau 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. +The Document API provides an *unsupported* 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: @@ -32,6 +32,6 @@ Features include: - Get all fields in a data source - Get all fields in use by certain sheets in a workbook -For Hyper files, take a look a the [Tableau Hyper API](https://help.tableau.com/current/api/hyper_api/en-us/index.html). +For Hyper files, take a look a the [Tableau Hyper API](https://tableau.github.io/hyper-db/docs/). We don't yet support creating files from scratch, adding extracts into workbooks or data sources, or updating field information. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..996f4af --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +lxml +setuptools +packaging +pycodestyle