meltano.edk


Namemeltano.edk JSON
Version 0.4.1 PyPI version JSON
download
home_pagehttps://meltano.com
SummaryA framework for building Meltano extensions
upload_time2024-02-06 14:35:12
maintainerMeltano Team and Contributors
docs_urlNone
authorMeltano Team and Contributors
requires_python>=3.8,<4
licenseApache 2.0
keywords meltano meltano extension meltano edk
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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)


            

Raw data

            {
    "_id": null,
    "home_page": "https://meltano.com",
    "name": "meltano.edk",
    "maintainer": "Meltano Team and Contributors",
    "docs_url": null,
    "requires_python": ">=3.8,<4",
    "maintainer_email": "",
    "keywords": "Meltano,Meltano Extension,Meltano EDK",
    "author": "Meltano Team and Contributors",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/59/be/3a21cfe4fe2ba6392ca075315389bc93c06e2ebdb0f0566d61bffa8e6710/meltano_edk-0.4.1.tar.gz",
    "platform": null,
    "description": "# Meltano extension developer kit\n\n[![Documentation Status](https://readthedocs.org/projects/meltano-edk/badge/?version=latest)](https://edk.meltano.com/en/latest/?badge=latest) |\n[![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)\n\nThe 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.\n\n## Creating a new extension using the EDK\n\nThis 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.\n\n### Prerequisites for using the template\n\nInstall copier:\n\n```bash\npipx install copier\n```\n\n### Use copier to initialize a new extension\n\nStart a new EDK project using the supplied template (directly from Github):\n\n```bash\ncopier gh:meltano/edk my-new-extension\n```\n\nInstall the project dependencies:\n\n```bash\ncd my-new-extension\npoetry install\n```\n\n## Developing extensions using the EDK\n\nFor 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).\n\nFor working examples of Meltano EDK extensions, see:\n\n- [dbt-ext](https://github.com/meltano/dbt-ext)\n- [cron-ext](https://github.com/meltano/cron-ext)\n\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "A framework for building Meltano extensions",
    "version": "0.4.1",
    "project_urls": {
        "Changelog": "https://github.com/meltano/edk/blob/main/CHANGELOG.md",
        "Homepage": "https://meltano.com",
        "Issue Tracker": "https://github.com/meltano/edk/issues",
        "Repository": "https://github.com/meltano/edk",
        "Slack": "https://meltano.com/slack",
        "Twitter": "https://twitter.com/meltanodata/",
        "Youtube": "https://www.youtube.com/meltano"
    },
    "split_keywords": [
        "meltano",
        "meltano extension",
        "meltano edk"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ad02ee1fc0538794b220940a1fa5debdbfc9e978353d64507481dc3a783695c6",
                "md5": "a1cece6b9943416ce5200755aa4e5b8d",
                "sha256": "ef7f96fc2155d2c9d5bbc5527e930c6e39b6614514977b91f7c9eb4644a4fdd2"
            },
            "downloads": -1,
            "filename": "meltano_edk-0.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a1cece6b9943416ce5200755aa4e5b8d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4",
            "size": 12771,
            "upload_time": "2024-02-06T14:35:10",
            "upload_time_iso_8601": "2024-02-06T14:35:10.366551Z",
            "url": "https://files.pythonhosted.org/packages/ad/02/ee1fc0538794b220940a1fa5debdbfc9e978353d64507481dc3a783695c6/meltano_edk-0.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "59be3a21cfe4fe2ba6392ca075315389bc93c06e2ebdb0f0566d61bffa8e6710",
                "md5": "f73a84fbe534d17ad86a36cb4bc2aa0c",
                "sha256": "26f8c4feac8b1d4e3f89203a3f0ebc2bd0befd5b55e76cf4608df45b78ef7ace"
            },
            "downloads": -1,
            "filename": "meltano_edk-0.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "f73a84fbe534d17ad86a36cb4bc2aa0c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4",
            "size": 11940,
            "upload_time": "2024-02-06T14:35:12",
            "upload_time_iso_8601": "2024-02-06T14:35:12.732663Z",
            "url": "https://files.pythonhosted.org/packages/59/be/3a21cfe4fe2ba6392ca075315389bc93c06e2ebdb0f0566d61bffa8e6710/meltano_edk-0.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-06 14:35:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "meltano",
    "github_project": "edk",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "meltano.edk"
}
        
Elapsed time: 0.20077s