From de7efa7393b8a252cdaa04907dfdd2be5ce3587d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edgar=20Ram=C3=ADrez-Mondrag=C3=B3n?= Date: Mon, 10 Feb 2025 13:47:20 -0600 Subject: [PATCH] Update readme --- README.md | 41 ++++++++--------------------------------- examples/README.md | 2 +- 2 files changed, 9 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index dceef05..9325642 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# `meltano-map-transformer` +# meltano-map-transformer @@ -8,7 +8,7 @@ A map transformer to duplicate, filter, hash, mask and do many more small transf This mapper plugin is fully compliant with the Singer Spec and can be placed in between any Singer tap and target. -# meltano-map-transformer in action +## meltano-map-transformer in action For a collection of examples, take a look at [examples/README.md](examples/README.md). @@ -31,15 +31,12 @@ You can see a full list of published releases [here](https://github.com/MeltanoL For example: -``` -# Update the below with the latest published release: -# https://github.com/MeltanoLabs/meltano-map-transform/releases - -# Install with pip, ideally in a new virtual environment to avoid conflicts: -pip install git+https://github.com/MeltanoLabs/meltano-map-transform.git@v0.4.1 +```shell +# Use `uv` so that virtual environments are managed automatically: +uv tool install meltano-map-transform==0.10.0 -# Or better yet, use `pipx` so that virtual environments are managed automatically: -pipx install git+https://github.com/MeltanoLabs/meltano-map-transform.git@v0.4.1 +# Alternatively, use `pipx`: +pipx install meltano-map-transform==0.10.0 ``` ### Meltano installation instructions @@ -63,7 +60,7 @@ pipx install git+https://github.com/MeltanoLabs/meltano-map-transform.git@v0.4.1 plugins: mappers: - name: meltano-map-transformer - pip_url: "git+https://github.com/MeltanoLabs/meltano-map-transform.git" + pip_url: meltano-map-transform executable: meltano-map-transform mappings: - name: hash_email @@ -84,9 +81,6 @@ pipx install git+https://github.com/MeltanoLabs/meltano-map-transform.git@v0.4.1 meltano run tap-csv hash_email target-sqlite ``` - - - ## Capabilities * `stream-maps` @@ -98,22 +92,3 @@ pipx install git+https://github.com/MeltanoLabs/meltano-map-transform.git@v0.4.1 | stream_maps | True | None | Stream maps | A full list of supported settings and capabilities is available by running: `meltano-map-transformer --about` - -## Installation - -We recommend using GitHub release tags when installing with `pip`. We also recommend using `pipx` or `meltano` instead of installing with `pip` directly. - -You can see a full list of published releases [here](https://github.com/MeltanoLabs/meltano-map-transform/releases). - -For example: - -``` -# Update the below with the latest published release: -# https://github.com/MeltanoLabs/meltano-map-transform/releases - -# Install with pip, ideally in a new virtual environment to avoid conflicts: -pip install git+https://github.com/MeltanoLabs/meltano-map-transform.git@v0.0.1 - -# Or better yet, use `pipx` so that virtual environments are managed automatically: -pipx install git+https://github.com/MeltanoLabs/meltano-map-transform.git@v0.0.1 -``` diff --git a/examples/README.md b/examples/README.md index f61326a..aa70856 100644 --- a/examples/README.md +++ b/examples/README.md @@ -10,7 +10,7 @@ Either clone this repository, or just open it up in codespaces. To execute the c To clean up afterwards, just remove the file: ```rm output/tap_csv.db``` # Example 1: Hashing with built-in functions -**What:** Splitting email adresses, save the domain in separate, hash the mail itself, remove "other" columns and use the "config" object. +**What:** Splitting email addresses, save the domain in separate, hash the mail itself, remove "other" columns and use the "config" object. **The configuration:** ```yaml