https://github.com/meltano/edk
Meltano extension development kit
https://github.com/meltano/edk
meltano python sdk
Last synced: 6 months ago
JSON representation
Meltano extension development kit
- Host: GitHub
- URL: https://github.com/meltano/edk
- Owner: meltano
- License: apache-2.0
- Created: 2022-08-23T20:52:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-11T12:30:22.000Z (6 months ago)
- Last Synced: 2024-11-11T13:28:25.118Z (6 months ago)
- Topics: meltano, python, sdk
- Language: Python
- Homepage: https://edk.meltano.com
- Size: 1010 KB
- Stars: 10
- Watchers: 5
- Forks: 3
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Meltano extension developer kit
[](https://edk.meltano.com/en/latest/?badge=latest) |
[](https://results.pre-commit.ci/latest/github/meltano/edk/main)
The Meltano extension developer kit is the fastest way to build custom Meltano extensions. If you're looking to build a custom extractor, loader, or tap then the [*SDK*](https://github.com/meltano/singer-sdk) is actually what you're looking for.
## Creating a new extension using the EDK
This repo ships with a [copier](https://copier.readthedocs.io/en/stable/) based template to help developers get and new extension using the [Meltano EDK](https://edk.meltano.com) up and running quickly.
### Prerequisites for using the template
Install copier:
```bash
pipx install copier
```
### Use copier to initialize a new extension
Start a new EDK project using the supplied template (directly from Github):
```bash
copier copy gh:meltano/edk my-new-extension
```
Install the project dependencies:
```bash
cd my-new-extension
poetry install
```
## Developing extensions using the EDK
For detailed instructions on developing Meltano EDK extensions, see the [Meltano EDK documentation](https://edk.meltano.com) and review the [Work-In-Progress Specification](https://meltano-edk--28.org.readthedocs.build/en/28/specification.html).
For working examples of Meltano EDK extensions, see:
- [dbt-ext](https://github.com/meltano/dbt-ext)
- [cron-ext](https://github.com/meltano/cron-ext)