Metadata-Version: 2.1
Name: meltano-edk
Version: 0.3.0
Summary: A framework for building Meltano extensions
Home-page: https://meltano.com
License: Apache 2.0
Keywords: Meltano,Meltano Extension,Meltano EDK
Author: Meltano Team and Contributors
Maintainer: Meltano Team and Contributors
Requires-Python: >=3.7,<3.12
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Typing :: Typed
Provides-Extra: docs
Requires-Dist: PyYAML (>=6.0.0,<7.0.0)
Requires-Dist: devtools (>=0.9.0,<1)
Requires-Dist: myst-parser (>=0.17.2,<0.19.0) ; extra == "docs"
Requires-Dist: pydantic (>=1.9.0,<2)
Requires-Dist: sphinx (>=4.5,<6.0) ; extra == "docs"
Requires-Dist: sphinx-autobuild (>=2021.3.14,<2022.0.0) ; extra == "docs"
Requires-Dist: sphinx-copybutton (>=0.3.1,<0.6.0) ; extra == "docs"
Requires-Dist: sphinx-rtd-theme (>=0.5.2,<1.3.0) ; extra == "docs"
Requires-Dist: structlog (>=21,<22)
Project-URL: Changelog, https://github.com/meltano/edk/blob/main/CHANGELOG.md
Project-URL: Issue Tracker, https://github.com/meltano/edk/issues
Project-URL: Repository, https://github.com/meltano/edk
Project-URL: Slack, https://meltano.com/slack
Project-URL: Twitter, https://twitter.com/meltanodata/
Project-URL: Youtube, https://www.youtube.com/meltano
Description-Content-Type: text/markdown

# Meltano extension developer kit

[![Documentation Status](https://readthedocs.org/projects/meltano-edk/badge/?version=latest)](https://edk.meltano.com/en/latest/?badge=latest) |
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/meltano/edk/main.svg)](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 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)

