semvec/pypi-packages huggingface dataset:
tableau-helpers 3.0.0.dev3
A collection of helpers to reduce boilerplate with Tableau APIs.
License: MIT License
Requires Python: >=3.9

# 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](./tests/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](./tests/test_server.py) for an example. 

## Development

There are a few steps to set up the development environment.
1. Make a copy of [.env.sample](.env.sample) and save it as .env
1. Add your [Personal Access Token](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.html) to .env
1. Set the tableau-server url in .env ex: `https://tableau-test.rki.local`
1. If your SSL cert is self signed, download a copy of your pem and provide the path in .env, otherwise delete the cert entry.
1. Install [tox](https://tox.wiki/en/latest/) either in an environment or for your user.
   1. Test run tox for unit tests `tox` (note: some integration tests require a connection to your tableau server)
   1. Test run tox to reformat files `tox -e lint`
1. Make commits using ticket/issue ids as a prefix of the commit message.

### Releases

1. Clean the build folder `rm build/*`, `rm dist/*`
1. Update the version of the package in [tableau_helpers/__init__.py](./tableau_helpers/__init__.py)
1. Package the library with `python -m build .`.
1. Review the contents of the package in the build folder.
1. Upload with twine to pypi `twine upload dist/*`.