CLI to make bulk updates to Quicksight datasets
Project description
quicksight-bulk-update-datasets
Makes bulk updates to Quicksight datasets.
[!NOTE] The only bulk update currently supported is a rename of table schema
Installation
pip install quicksight-bulk-update-datasets
Usage
quicksight-bulk-update-datasets [OPTIONS] ACCOUNT_ID SOURCE_SCHEMA TARGET_SCHEMA
Arguments:
ACCOUNT_ID: [required]SOURCE_SCHEMA: [required]TARGET_SCHEMA: [required]
Options:
--aws-profile TEXT--dataset-id TEXT--no-prompt / --no-no-prompt: [default: no-no-prompt]--dry-run / --no-dry-run: [default: no-dry-run]--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help: Show help and exit.
Contributing
Prerequisites
To contribute you'll need:
- Familiarity with the command line, for example by taking a course on Bash and Z Shell
- A GitHub account
- Git installed
- Python installed
- A text editor or integrated development environment (IDE), for example VS Code
You may also need to refer to the following as you're making changes:
Get the code
If you're not a member of the uktrade GitHub organisation, you should:
-
Fork this repo at https://github.com/uktrade/quicksight-bulk-update-datasets/fork
-
Clone the fork by running the following, replacing
my-username-or-orgwith the username or organisation name you forked to:git clone git@github.com:my-username-or-org/quicksight-bulk-update-datasets.git cd quicksight-bulk-update-datasets.
If you are a member the uktrade GitHub organisation, you should:
-
Clone this repo directly:
git clone git@github.com:uktrade/quicksight-bulk-update-datasets.git cd quicksight-bulk-update-datasets
Install in editable mode
pip install -e .
Generating docs
pip install typer-cli
typer quicksight_bulk_update_datasets.py utils docs --name quicksight-bulk-update-datasets --output docs.md
Then manually copy and tweaking the docs from docs.md to the Usage section in README.md.
Releasing
After merging to the main branch, create a release from the Releases page.
- The tag must be the form "vX.Y.Z" where X.Y.Z is the new SemVer 2.0 version.
- You should press "Generate release notes" to automatically bring in titles of PRs since the previous release.
- If there are many PRs, you should include an introductory paragraph highlighting the main changes.
Creating a GitHub release will automatically run the GitHub Actions workflow that releases to PyPI.
Only members of the uktrade GitHub organisation may create releases.
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 quicksight_bulk_update_datasets-0.0.15.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 56f18cfe22ca9351d954a5bf3b3249a5fa6b358c2e4cb6d89a4db3ead4746130 |
|
| MD5 | 71e50a1985a4dc422a06ee6012f3a928 |
|
| BLAKE2b-256 | 9b76998c20e091cee8a6052ce12d59d150516a9261a1bf8792da49811b1b03c6 |
Hashes for quicksight_bulk_update_datasets-0.0.15-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 964c11378e41c6a5676624d8d8959ebf1f3d296fc8e48d9ff62ad6cd3982e9bc |
|
| MD5 | 801233abe9d5308411b5cb1064cc2541 |
|
| BLAKE2b-256 | 44c1005bff45410e838eff4337cf53546eeb56f14f680f2941734d8e2e53a7ba |
