meltano-edk


Namemeltano-edk JSON
Version 0.3.0 PyPI version JSON
download
home_pagehttps://meltano.com
SummaryA framework for building Meltano extensions
upload_time2023-02-09 22:25:37
maintainerMeltano Team and Contributors
docs_urlNone
authorMeltano Team and Contributors
requires_python>=3.7,<3.12
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.7,<3.12",
    "maintainer_email": "",
    "keywords": "Meltano,Meltano Extension,Meltano EDK",
    "author": "Meltano Team and Contributors",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/14/a5/c42a3ee9f5a2770ac501340c2120394141955014a0ca1e7f24755e5819ec/meltano_edk-0.3.0.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",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "A framework for building Meltano extensions",
    "version": "0.3.0",
    "split_keywords": [
        "meltano",
        "meltano extension",
        "meltano edk"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a6a949b4c12749233f917c1ab8e05ff4081820a49dbc4decf7375cfc1a1a4bc5",
                "md5": "b2951945b767a477c9a80e293fbd22de",
                "sha256": "66bd87ca80f3e3323022de3ddfc16da4d9b10eef420bb9284cab56945b05b97f"
            },
            "downloads": -1,
            "filename": "meltano_edk-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b2951945b767a477c9a80e293fbd22de",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<3.12",
            "size": 12691,
            "upload_time": "2023-02-09T22:25:35",
            "upload_time_iso_8601": "2023-02-09T22:25:35.848314Z",
            "url": "https://files.pythonhosted.org/packages/a6/a9/49b4c12749233f917c1ab8e05ff4081820a49dbc4decf7375cfc1a1a4bc5/meltano_edk-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "14a5c42a3ee9f5a2770ac501340c2120394141955014a0ca1e7f24755e5819ec",
                "md5": "cd668afe3bfd4ab822900823e7c31ef5",
                "sha256": "4783730042a7ae0cdf0b65de5f3a40ba8fb26cafc0f6fa8b352cb5926873c04a"
            },
            "downloads": -1,
            "filename": "meltano_edk-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "cd668afe3bfd4ab822900823e7c31ef5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<3.12",
            "size": 12238,
            "upload_time": "2023-02-09T22:25:37",
            "upload_time_iso_8601": "2023-02-09T22:25:37.804924Z",
            "url": "https://files.pythonhosted.org/packages/14/a5/c42a3ee9f5a2770ac501340c2120394141955014a0ca1e7f24755e5819ec/meltano_edk-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-02-09 22:25:37",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "meltano-edk"
}
        
Elapsed time: 0.14670s