Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
edgarrmondragon committed Feb 10, 2025
1 parent ce7a093 commit de7efa7
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 34 deletions.
41 changes: 8 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# `meltano-map-transformer`
# meltano-map-transformer

<img src="examples/mapperpic.png" width="800px"/>

Expand All @@ -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).

Expand All @@ -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/[email protected]
```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[email protected]
# Alternatively, use `pipx`:
pipx install meltano-map-transform==0.10.0
```

### Meltano installation instructions
Expand All @@ -63,7 +60,7 @@ pipx install git+https://github.com/MeltanoLabs/[email protected]
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
Expand All @@ -84,9 +81,6 @@ pipx install git+https://github.com/MeltanoLabs/[email protected]
meltano run tap-csv hash_email target-sqlite
```




## Capabilities

* `stream-maps`
Expand All @@ -98,22 +92,3 @@ pipx install git+https://github.com/MeltanoLabs/[email protected]
| 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/[email protected]
# Or better yet, use `pipx` so that virtual environments are managed automatically:
pipx install git+https://github.com/MeltanoLabs/[email protected]
```
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit de7efa7

Please sign in to comment.