diff --git a/Community-Supported/README.md b/Community-Supported/README.md index e83e4d6..55096fd 100644 --- a/Community-Supported/README.md +++ b/Community-Supported/README.md @@ -34,9 +34,9 @@ The community samples focus on individual use cases and are Python-only. They ha - This sample is based on the content the Hyper team presented in the Hands on Training session "Hands-on: Leverage the Hyper Update API and Hyper API to Keep Your Data Fresh on Tableau Server" at Tableau Conference 2022 ([slides available here](https://mkt.tableau.com/tc22/sessions/live/430-HOT-D1_Hands-onLeverageTheHyperUpdate.pdf)). It demonstrates how to implement an incremental refresh based on the Hyper API and the [Hyper Update API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_how_to_update_data_to_hyper.htm). It showcases this based on fligths data from the [OpenSkyAPI](https://github.com/openskynetwork/opensky-api). -- [__s3-compatible-services__](https://github.com/aetperf/hyper-api-samples/tree/main/Community-Supported/s3-compatible-services) +- [__s3-compatible-services__](https://github.com/tableau/hyper-api-samples/tree/main/Community-Supported/s3-compatible-services) - Demonstrates how Hyper can natively interact with S3 compatible services, such as Google Storage, without the need to install any external dependencies like `google-cloud-bigquery`. -- [__git-to-hyper__](https://github.com/aetperf/hyper-api-samples/tree/main/Community-Supported/git-to-hyper) +- [__git-to-hyper__](https://github.com/tableau/hyper-api-samples/tree/main/Community-Supported/git-to-hyper) - Demonstrates how to parse meta data of git and store it in a Hyper file for further analysis.
diff --git a/Community-Supported/git-to-hyper/README.md b/Community-Supported/git-to-hyper/README.md index 64cb2bb..97cbf54 100644 --- a/Community-Supported/git-to-hyper/README.md +++ b/Community-Supported/git-to-hyper/README.md @@ -28,7 +28,7 @@ To run the script, you will need: $ git clone https://github.com/tableau/hyper-api-samples.git $ cd hyper-api-samples $ pip3 install -r Community-Supported/git-to-hyper/requirements.txt -$ python Community-Supported/git-to-hyper/basic-git-to-hyper.py --path_to_repo ~/sample/repository +$ python Community-Supported/git-to-hyper/basic-git-to-hyper.py ~/sample/repository ``` The basic sample is a very lightweight example of how to extract meta data from git and save it into a Hyper database. It extracts only very high-level information like timestamps of commits, their authors and metrics like number of added lines. @@ -55,7 +55,7 @@ The script will generate a `git.hyper` file which can be used in Tableau for fur $ git clone https://github.com/tableau/hyper-api-samples.git $ cd hyper-api-samples $ pip3 install -r Community-Supported/git-to-hyper/requirements.txt -$ python Community-Supported/git-to-hyper/advanced-git-to-hyper.py --path_to_repo ~/sample/repository +$ python Community-Supported/git-to-hyper/advanced-git-to-hyper.py ~/sample/repository ``` The advanced sample gathers further data by e.g. running `git blame` for every changed file to count the source lines of code for every author. The results are stored in multiple tables inside the Hyper file and `FOREIGN_KEY` is used to link them together (see [here](https://github.com/tableau/hyper-api-samples/tree/main/Community-Supported/publish-multi-table-hyper) for a detailed explanation on how to use multiple tables in Hyper). diff --git a/Community-Supported/hyper-to-csv/README.md b/Community-Supported/hyper-to-csv/README.md index 270fabf..c30b42e 100644 --- a/Community-Supported/hyper-to-csv/README.md +++ b/Community-Supported/hyper-to-csv/README.md @@ -18,7 +18,7 @@ To run the script, you will need: ## Run the sample -Running hyper-to-csv.py will transform a given hyper file into a CSV. Simply change the values of `hyper_name`, `my_table`, and `output_name` to match your use case. Note that `my_table` is an object that can take both the table name, as well as the schema name. See more on this in the [TableName documentation](https://tableau.github.io/hyper-db/lang_docs/py/tableauhyperapi.html#tableauhyperapi.TableName). +Running hyper-to-csv.py will transform a given hyper file into a CSV. Simply change the values of `hyper_file_path`, `table_name`, and `output_name` to match your use case. Note that `table_name` is an object that can take both the table name, as well as the schema name. See more on this in the [TableName documentation](https://tableau.github.io/hyper-db/lang_docs/py/tableauhyperapi.html#tableauhyperapi.TableName). Instead of leveraging the `insert_data()` method, you will simply reference an existing `.hyper` file and use the `convert_to_csv()` method. The sample database created in the script is for demonstrative purposes only. diff --git a/Community-Supported/s3-compatible-services/requirements.txt b/Community-Supported/s3-compatible-services/requirements.txt new file mode 100644 index 0000000..9bd621a --- /dev/null +++ b/Community-Supported/s3-compatible-services/requirements.txt @@ -0,0 +1 @@ +tableauhyperapi>=0.0.14946