Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some formatting nits #1256

Open
wants to merge 2 commits into
base: gh-pages
Choose a base branch
from
Open

Fix some formatting nits #1256

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff72352
Update tdvt.md
lukewrites Sep 12, 2024
b4baded
hopefully fix more formatting
lukewrites Sep 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 22 additions & 11 deletions docs/tdvt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,24 +76,36 @@ You can create an archive package and install that, or install from the live dir
$ source tdvt-venv/bin/activate
```

or on Windows:
or on Windows:

```
D:\src> python -m venv ./tdvt-venv
D:\src> tdvt-venv/Scripts/activate.bat
```

You will know your venv is activated if (tdvt-venv) appears before your prompt. Alternatively, do a $which python to make sure it's pointing to a python executable in /tdvt-venv

Install TDVT:

```
$ (tdvt-venv) cd connector-plugin-sdk/tdvt
$ (tdvt-venv) pip install -e .
```
The . at the end is important.

Verify it is installed:
```pip list````


The `.` at the end is important.

You can then verify TDVT is installed:

```
$ (tdvt-venv) pip list
Package Version Location
---------- ------- -------------------------------------------------
defusedxml 0.7.1
pip 21.2.4
setuptools 58.0.4
tdvt 2.13.7 /your/working/dir/connector-plugin-sdk/tdvt
```
Note that TDVT's `Location` is where you cloned the package.
1. Extract and then load the [TestV1 dataset](https://github.com/tableau/connector-plugin-sdk/tree/master/tests/datasets/TestV1) into your database.
__Notes:__
- See [Postgres Example](https://github.com/tableau/connector-plugin-sdk/tree/master/tests/datasets/TestV1/postgres/README.md) for an example of loading data into a database
Expand Down Expand Up @@ -124,14 +136,14 @@ __Note:__ For setting up TDVT using Tableau Linux Server please click [here](/co

## About running TDVT

- When TDVT is installed as a Python module, invoke it as follows:
`python -m tdvt.tdvt`
- When TDVT is installed as a Python module, call it as a module:
`$ python -m tdvt.tdvt`
- Make sure you're using the correctly using Python 3 if you have multiple versions of python installed.
- TDVT makes searches relative to the current working directory to find the config and setup files it needs.
- Always run TDVT commands from the top-level directory of your generated folder structure.
- Use double quotes to wrap arguments that contain spaces.

`tdvt run mydb --generate` is used to update some config files.
`python -m tdvt.tdvt run mydb --generate` is used to update some config files.
You need to run it if you add a new data source or change your mydb.ini file.

## Test a new data source
Expand Down Expand Up @@ -267,8 +279,7 @@ To create custom tests, you need to create a json file that describes your table
**`nulls` and `empties`**: Enter `true` or `false` for each of the following:

Data Shape | Description | Calcs Reference Column
-|-|-

- | - | -
`nulls` | Fields in the column may contain a null value. | [int1](https://github.com/tableau/connector-plugin-sdk/blob/master/tests/datasets/TestV1/Calcs_headers.csv)
`empties` | Fields in the column may contain no data (e.g. an empty string). | [datetime1](https://github.com/tableau/connector-plugin-sdk/blob/master/tests/datasets/TestV1/Calcs_headers.csv)

Expand Down