hidden fields, schema and service fields (#231)

Author: jacalata

.github/workflows/publish-pypi.yml

@@ -0,0 +1,56 @@
+name: Publish to PyPi
+
+on:
+  workflow_dispatch:
+  release:
+    types: [created]
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      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
+        pip install wheel
+        if [ -f  requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Package
+      run: | 
+        python setup.py sdist
+        python setup.py bdist_wheel
+        
+
+  test-deploy:
+  if: github.ref_type == 'tag' && contains(github.ref_name, 'test')
+    needs: build
+    environment:
+      name: test-pypi
+    runs-on: ubuntu-latest
+    steps:
+    - name: Publish 📦 to Test PyPI
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        password: ${{ secrets.TEST_PYPI_TOKEN }}
+        repository_url: https://test.pypi.org/legacy/
+
+
+  production-deploy:
+    needs: build
+    environment:
+      name: pypi
+    runs-on: ubuntu-latest
+    steps:
+    - name: Publish 📦 to Real PyPI
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}
+        repository_url: https://pypi.org/legacy/

.github/workflows/python-package.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.7, 3.8, 3.9]
+        python-version: [3.7, 3.8, 3.9, 3.10]
 
     steps:
     - uses: actions/checkout@v2

CHANGELOG.md

@@ -1,20 +1,16 @@
-## 09 (December 2021)
-* Pypi upgraded to Python3
 
-## 08 (October 2021)
-* See dashboards in a workbook
-* Add shapes property
-* Add custom sql
-* Drop python 2, add up through 3.9
+## 091 (March 2022)
+* Add attribute for hidden field
 
+## 09 (December 2021)
+* Pypi upgraded to Python3
 
 ## 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
 

README.md

@@ -1,5 +1,5 @@
 # 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) [![Build Status](https://travis-ci.org/tableau/document-api-python.svg?branch=master)](https://travis-ci.org/tableau/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)
 
 This repo contains Python source and example files for the Tableau Document API. 
 
@@ -29,6 +29,6 @@ Features include:
 
 For Hyper files, take a look a the [Tableau Hyper API](https://help.tableau.com/current/api/hyper_api/en-us/index.html).
 
-We don't yet support creating files from scratch, adding extracts into workbooks or data sources, or updating field information
+We don'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.

docs/docs/api-ref.md

@@ -52,23 +52,27 @@ A class representing Tableau Data Sources, embedded in workbook files or in TDS
 
 **Methods:**
 
-save
+`Datasource.save(self)` Saves any changes to the datasource to the existing file.
 
-save_as
+`Datasource.save_as(self)` Saves any changes to the datasource to a new file specified by the `new_file` parameter.
 
-add_calculation
+`Datasource.add_field(self, name, datatype, role, field_type, caption)` Adds a base field object with the given values.
 
-**Properities:**
+`Datasource.remove_field(self, field)` Remove a given field.
+
+`Datasource.add_calculation(self, caption, formula, datatype, role, type)` Adds a calculated field with the given values.
+
+**Properties:**
 
 `self.name` Returns string with the name of datasource.
 
 `self.version` Returns string of daatasource's version.
 
 `self.caption` Returns string of user defined name of datasource if exists.
 
-`self.connections` Returns list of connections are used in workbook.
+`self.connections` Returns list of connections used in workbook.
 
-`self.fileds` Returns key-value result of field name and their attributes.
+`self.fields` Returns key-value result of field name and their attributes.
 
 `self.calculations` Returns calculated field of the workbook.
 
@@ -115,7 +119,7 @@ Represents a field in a datasource
 
 `Field.add_alias(self, key, value)` Add an alias for a given display value.
 
-**Properities:**
+**Properties:**
 
 `self.name` Returns a string providing a nice name for the field which is derived from the alias, caption, or the id.
 

publish.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-
+pip install wheel
 set -e
 
 rm -rf dist