| Name | tableau-toolkit JSON |
| Version |
0.1.12
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2025-02-08 19:06:24 |
| maintainer | None |
| docs_url | None |
| author | Albert Wong |
| requires_python | ==3.13 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Tableau Toolkit
## Development Process
### Prerequisites
* Git - https://git-scm.com/
* Poetry - https://python-poetry.org/
* Python (3.13) - https://www.python.org/
### Get Project
`git clone <this repository>`
### Install Dependencies
`poetry install`
### Black to Standardize Code Formatting
`poetry run black tableau_toolkit`
### Pylint to Improve Code Readability
`poetry run pylint tableau_toolkit`
### Run unit tests
`poetry run test`
### Run cli commands
`poetry run tt`
### Build
`poetry build`
### Publish
`poetry config pypi-token.pypi <your-api-token> # do this only your first time`
`poetry publish --skip-existing`
### Installer
`poetry run postbuild`
installer.iss - Load it into 'Inno Setup' application to create Windows installer, then remove/install as needed
* install: double click on installer in output directory
* remove: use add or remove programs from start menu and search for Tableau Toolkit
create_pkg.sh - Run it to create installer for MacOS, then remove/install as needed
* install: double click on pkg file in output directory
* remove: rm /usr/local/bin/tt
create_deb.sh - create deb installer, then remove/install as needed
* install: sudo dpkg -i *./output/filename.deb*
* remove: sudo dpkg -r *packagename*
create_rpm.sh - create rpm installer, then remove/install as needed
* install: sudo rpm -i *./output/filename.rpm*
* remove: sudo rpm -e *packagename*
## Usage
Once published, users can install and use
### Install
`pip install tableau-toolkit`
### Usage
#### First Time
If this is the first time using the tableau toolkit,
execute the following command to create a config file.
This only needs to be done once.
`tt init`
A file will appear at `.tableau_toolkit/.tableau.yaml`
in your home directory.
Next, Fill in the information in the generated config file.
For any field with the comment `# provide encoded string`,
use `tt encode <string>` to generate the encoded string for the config file
```
api:
version: '3.21'
authentication:
type: personal_access_token
personal_access_token:
name: api
secret: # provide encoded string
postgres:
database: workgroup
host: localhost
password:
port: 8060
user: readonly
site:
content_url: ''
tableau_auth:
password: # provide encoded string
username:
tableau_server:
url: # url for api access
public_url: # url for end user access
```
#### Ready to Use
Next, execute `tt` to get a list of commands. Some example commands are listed below
```
tt get data-alerts --limit 10000000 --columns "object_type,object_name,object_luid,object_owner_username,object_location,object_size,site_name,site_luid,days_since_last_event,snapshot_at"
tt get extract-refreshes --no-headers --limit 10000000 --columns "object_type,object_name,object_luid,object_owner_username,object_location,object_size,site_name,site_luid,days_since_last_event,snapshot_at"
tt get subscriptions --no-headers --limit 10000000 --columns "object_type,object_name,object_luid,object_owner_username,object_location,object_size,site_name,site_luid,days_since_last_event,snapshot_at"
tt get workbooks --no-headers --limit 10000000 --columns "object_type,object_name,object_luid,object_owner_username,object_location,object_size,site_name,site_luid,days_since_last_event,snapshot_at"
tt get datasources --no-headers --limit 10000000 --columns "object_type,object_name,object_luid,object_owner_username,object_location,object_size,site_name,site_luid,days_since_last_event,snapshot_at"
tt get views --no-headers --limit 10000000 --columns "object_type,object_name,object_luid,object_owner_username,object_location,object_size,site_name,site_luid,days_since_last_event,snapshot_at"
tt get users --no-headers --limit 10000000 --columns "object_type,object_name,object_luid,object_owner_username,object_location,object_size,site_name,site_luid,days_since_last_event,snapshot_at"
```
Raw data
{
"_id": null,
"home_page": null,
"name": "tableau-toolkit",
"maintainer": null,
"docs_url": null,
"requires_python": "==3.13",
"maintainer_email": null,
"keywords": null,
"author": "Albert Wong",
"author_email": "albert.wong@salesforce.com",
"download_url": "https://files.pythonhosted.org/packages/e2/5e/191814c81ae4b0cde1808ff4284098883f2a97d070bd1aa6520a92b9d0bd/tableau_toolkit-0.1.12.tar.gz",
"platform": null,
"description": "# Tableau Toolkit\n\n\n## Development Process\n\n### Prerequisites\n\n* Git - https://git-scm.com/\n* Poetry - https://python-poetry.org/\n* Python (3.13) - https://www.python.org/\n\n### Get Project\n`git clone <this repository>`\n\n### Install Dependencies\n`poetry install`\n\n### Black to Standardize Code Formatting\n`poetry run black tableau_toolkit`\n\n### Pylint to Improve Code Readability\n`poetry run pylint tableau_toolkit`\n\n### Run unit tests\n`poetry run test`\n\n### Run cli commands\n`poetry run tt`\n\n\n### Build \n`poetry build`\n\n### Publish\n`poetry config pypi-token.pypi <your-api-token> # do this only your first time`\n\n`poetry publish --skip-existing`\n\n### Installer\n\n`poetry run postbuild`\n\ninstaller.iss - Load it into 'Inno Setup' application to create Windows installer, then remove/install as needed\n\n* install: double click on installer in output directory\n* remove: use add or remove programs from start menu and search for Tableau Toolkit\n\ncreate_pkg.sh - Run it to create installer for MacOS, then remove/install as needed\n\n* install: double click on pkg file in output directory\n* remove: rm /usr/local/bin/tt\n\ncreate_deb.sh - create deb installer, then remove/install as needed\n\n* install: sudo dpkg -i *./output/filename.deb*\n* remove: sudo dpkg -r *packagename*\n\ncreate_rpm.sh - create rpm installer, then remove/install as needed\n\n* install: sudo rpm -i *./output/filename.rpm*\n* remove: sudo rpm -e *packagename*\n\n## Usage\n\nOnce published, users can install and use\n\n### Install\n`pip install tableau-toolkit`\n\n### Usage\n\n#### First Time\nIf this is the first time using the tableau toolkit, \nexecute the following command to create a config file. \nThis only needs to be done once.\n\n`tt init`\n\nA file will appear at `.tableau_toolkit/.tableau.yaml`\nin your home directory. \n\nNext, Fill in the information in the generated config file. \nFor any field with the comment `# provide encoded string`, \nuse `tt encode <string>` to generate the encoded string for the config file\n\n```\napi:\n version: '3.21'\nauthentication:\n type: personal_access_token\npersonal_access_token:\n name: api\n secret: # provide encoded string\npostgres:\n database: workgroup\n host: localhost\n password: \n port: 8060\n user: readonly\nsite:\n content_url: ''\ntableau_auth:\n password: # provide encoded string\n username: \ntableau_server:\n url: # url for api access\n public_url: # url for end user access\n```\n\n#### Ready to Use\nNext, execute `tt` to get a list of commands. Some example commands are listed below\n\n```\n\ntt get data-alerts --limit 10000000 --columns \"object_type,object_name,object_luid,object_owner_username,object_location,object_size,site_name,site_luid,days_since_last_event,snapshot_at\" \n\ntt get extract-refreshes --no-headers --limit 10000000 --columns \"object_type,object_name,object_luid,object_owner_username,object_location,object_size,site_name,site_luid,days_since_last_event,snapshot_at\" \n\ntt get subscriptions --no-headers --limit 10000000 --columns \"object_type,object_name,object_luid,object_owner_username,object_location,object_size,site_name,site_luid,days_since_last_event,snapshot_at\" \n\ntt get workbooks --no-headers --limit 10000000 --columns \"object_type,object_name,object_luid,object_owner_username,object_location,object_size,site_name,site_luid,days_since_last_event,snapshot_at\" \n\ntt get datasources --no-headers --limit 10000000 --columns \"object_type,object_name,object_luid,object_owner_username,object_location,object_size,site_name,site_luid,days_since_last_event,snapshot_at\" \n\ntt get views --no-headers --limit 10000000 --columns \"object_type,object_name,object_luid,object_owner_username,object_location,object_size,site_name,site_luid,days_since_last_event,snapshot_at\" \n\ntt get users --no-headers --limit 10000000 --columns \"object_type,object_name,object_luid,object_owner_username,object_location,object_size,site_name,site_luid,days_since_last_event,snapshot_at\"\n\n```\n\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.1.12",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "081854ea7d3baf78a256873ace2209c5fb83d8533ab3b538533b0b7e1460585f",
"md5": "c0aaecb79324e8ac151050bdcf5c2d72",
"sha256": "098da927564b6d0fe69030c81851c37578626c566472afe134d94edb5a3ec5d2"
},
"downloads": -1,
"filename": "tableau_toolkit-0.1.12-cp313-cp313-macosx_15_0_x86_64.whl",
"has_sig": false,
"md5_digest": "c0aaecb79324e8ac151050bdcf5c2d72",
"packagetype": "bdist_wheel",
"python_version": "cp313",
"requires_python": "==3.13",
"size": 43845,
"upload_time": "2025-02-08T19:06:23",
"upload_time_iso_8601": "2025-02-08T19:06:23.160253Z",
"url": "https://files.pythonhosted.org/packages/08/18/54ea7d3baf78a256873ace2209c5fb83d8533ab3b538533b0b7e1460585f/tableau_toolkit-0.1.12-cp313-cp313-macosx_15_0_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e25e191814c81ae4b0cde1808ff4284098883f2a97d070bd1aa6520a92b9d0bd",
"md5": "93692c0ff21ffce1728e3dfeaa594541",
"sha256": "0eb6d0a59962b34ff6deff0fb0617656e1f6c39a4088f3d7949ceac3ab344f5d"
},
"downloads": -1,
"filename": "tableau_toolkit-0.1.12.tar.gz",
"has_sig": false,
"md5_digest": "93692c0ff21ffce1728e3dfeaa594541",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "==3.13",
"size": 31749,
"upload_time": "2025-02-08T19:06:24",
"upload_time_iso_8601": "2025-02-08T19:06:24.961033Z",
"url": "https://files.pythonhosted.org/packages/e2/5e/191814c81ae4b0cde1808ff4284098883f2a97d070bd1aa6520a92b9d0bd/tableau_toolkit-0.1.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-08 19:06:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tableau-toolkit"
}
