A collection of helpers to reduce boilerplate with Tableau APIs.
Project description
tableau_helpers
A wrapper for the tableau-server-client and hyper-api which abstracts away boilerplate and in some cases provides a CLI which works without admin privileges. The CLI is in beta, and parameters may change with minor releases.
tableau_helpers.hyper
Create hyperfiles from one or more csvs by providing a source, destination, schema, and optional parameters.
Code integration
See test_hyper.py for some examples in action.
tableau_helpers.publish
Upload datasources from your machine to the tableau server by providing a hyperfile as a source and a project as a destination.
Code integration
See test_server.py for an example.
Development
There are a few steps to set up the development environment.
- Make a copy of .env.sample and save it as .env
- Add your Personal Access Token to .env
- Set the tableau-server url in .env ex:
https://tableau-test.rki.local
- If your SSL cert is self signed, download a copy of your pem and provide the path in .env, otherwise delete the cert entry.
- Install tox either in an environment or for your user.
- Test run tox for unit tests
tox
(note: some integration tests require a connection to your tableau server) - Test run tox to reformat files
tox -e lint
- Test run tox for unit tests
- Make commits using ticket/issue ids as a prefix of the commit message.
Releases
- Clean the build folder
rm build/*
,rm dist/*
- Update the version of the package in tableau_helpers/init.py
- Package the library with
python -m build .
. - Review the contents of the package in the build folder.
- Upload with twine to pypi
twine upload dist/*
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tableau-helpers-3.0.0.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3897e35dd2ff7cf7c521ac10414c6925a464fc54ce361b6965c7fc83005d5025 |
|
MD5 | 54cdbabd437fea9ca344c2f484852445 |
|
BLAKE2b-256 | 0299fc093b9c9958560557091e58f11de86395f73c24c25b20e4120bea3a65dc |
Hashes for tableau_helpers-3.0.0.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4b285a2225689b3e4f6fcb880d4fb6a7faf0928a95c6c7cd9948f891acd331a |
|
MD5 | c93fb30e14c1e0b5c1cd35935ed67ec1 |
|
BLAKE2b-256 | 5dc649ba7130c282460efcfeeead3338fe638b938b1f53e0258f686baf1609c8 |