airflow-dag-artifact


Nameairflow-dag-artifact JSON
Version 0.2.1 PyPI version JSON
download
home_pagehttps://github.com/MacHu-GWU/airflow_dag_artifact-project
SummaryAirflow Dag Artifact versioning and alias Management for blue/green, canary deployment, and roll back for production failure.
upload_time2023-07-13 01:12:27
maintainerSanhe Hu
docs_urlNone
authorSanhe Hu
requires_python
licenseMIT
keywords
VCS
bugtrack_url
requirements boto3 s3pathlib versioned
Travis-CI No Travis.
coveralls test coverage
            
.. .. image:: https://readthedocs.org/projects/airflow-dag-artifact/badge/?version=latest
    :target: https://airflow-dag-artifact.readthedocs.io/en/latest/
    :alt: Documentation Status

.. image:: https://github.com/MacHu-GWU/airflow_dag_artifact-project/workflows/CI/badge.svg
    :target: https://github.com/MacHu-GWU/airflow_dag_artifact-project/actions?query=workflow:CI

.. image:: https://codecov.io/gh/MacHu-GWU/airflow_dag_artifact-project/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/MacHu-GWU/airflow_dag_artifact-project

.. image:: https://img.shields.io/pypi/v/airflow-dag-artifact.svg
    :target: https://pypi.python.org/pypi/airflow-dag-artifact

.. image:: https://img.shields.io/pypi/l/airflow-dag-artifact.svg
    :target: https://pypi.python.org/pypi/airflow-dag-artifact

.. image:: https://img.shields.io/pypi/pyversions/airflow-dag-artifact.svg
    :target: https://pypi.python.org/pypi/airflow-dag-artifact

.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social
    :target: https://github.com/MacHu-GWU/airflow_dag_artifact-project/blob/main/release-history.rst

.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
    :target: https://github.com/MacHu-GWU/airflow_dag_artifact-project

------

.. .. image:: https://img.shields.io/badge/Link-Document-blue.svg
    :target: https://airflow-dag-artifact.readthedocs.io/en/latest/

.. .. image:: https://img.shields.io/badge/Link-API-blue.svg
    :target: https://airflow-dag-artifact.readthedocs.io/en/latest/py-modindex.html

.. image:: https://img.shields.io/badge/Link-Install-blue.svg
    :target: `install`_

.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
    :target: https://github.com/MacHu-GWU/airflow_dag_artifact-project

.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
    :target: https://github.com/MacHu-GWU/airflow_dag_artifact-project/issues

.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
    :target: https://github.com/MacHu-GWU/airflow_dag_artifact-project/issues

.. image:: https://img.shields.io/badge/Link-Download-blue.svg
    :target: https://pypi.org/pypi/airflow-dag-artifact#files


Welcome to ``airflow_dag_artifact`` Documentation
==============================================================================
A lot of serverless AWS Service supports versioning and alias for deployment. It made the blue / green deployment, canary deployment and rolling back super easy.

- `AWS Lambda Versioning and Alias <https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html>`_
- `AWS StepFunction Versioning and Alias <https://docs.aws.amazon.com/step-functions/latest/dg/auth-version-alias.html>`_
- `AWS SageMaker Model Registry Versioning <https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry.html>`_

However, Airflow DAG does not support this feature yet. This library provides a way to manage Airflow DAG versioning and alias so you can deploy Airflow DAG with confidence.

Please `read this tutorial <https://github.com/MacHu-GWU/airflow_dag_artifact-project/blob/main/examples/deploy_versioned_airflow_dag_artifacts.ipynb>`_ to learn how to use this library.

It also has native `AWS MWAA <https://aws.amazon.com/managed-workflows-for-apache-airflow/>`_ support for DAG deployment automation, with the DAG versioning manage, which is not official supported by Apache Airflow. Please `read this example <https://github.com/MacHu-GWU/airflow_dag_artifact-project/blob/main/examples/aws_mwaa.py>`_ to learn how to use this library with AWS MWAA.


.. _install:

Install
------------------------------------------------------------------------------

``airflow_dag_artifact`` is released on PyPI, so all you need is to:

.. code-block:: console

    $ pip install airflow-dag-artifact

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade airflow-dag-artifact

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/MacHu-GWU/airflow_dag_artifact-project",
    "name": "airflow-dag-artifact",
    "maintainer": "Sanhe Hu",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "husanhe@gmail.com",
    "keywords": "",
    "author": "Sanhe Hu",
    "author_email": "husanhe@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/06/6c/578cc3cc4658d85f45e72f13e24185c7f986b908412d41c769f8c2b9ce5b/airflow_dag_artifact-0.2.1.tar.gz",
    "platform": "Windows",
    "description": "\n.. .. image:: https://readthedocs.org/projects/airflow-dag-artifact/badge/?version=latest\n    :target: https://airflow-dag-artifact.readthedocs.io/en/latest/\n    :alt: Documentation Status\n\n.. image:: https://github.com/MacHu-GWU/airflow_dag_artifact-project/workflows/CI/badge.svg\n    :target: https://github.com/MacHu-GWU/airflow_dag_artifact-project/actions?query=workflow:CI\n\n.. image:: https://codecov.io/gh/MacHu-GWU/airflow_dag_artifact-project/branch/main/graph/badge.svg\n    :target: https://codecov.io/gh/MacHu-GWU/airflow_dag_artifact-project\n\n.. image:: https://img.shields.io/pypi/v/airflow-dag-artifact.svg\n    :target: https://pypi.python.org/pypi/airflow-dag-artifact\n\n.. image:: https://img.shields.io/pypi/l/airflow-dag-artifact.svg\n    :target: https://pypi.python.org/pypi/airflow-dag-artifact\n\n.. image:: https://img.shields.io/pypi/pyversions/airflow-dag-artifact.svg\n    :target: https://pypi.python.org/pypi/airflow-dag-artifact\n\n.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social\n    :target: https://github.com/MacHu-GWU/airflow_dag_artifact-project/blob/main/release-history.rst\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n    :target: https://github.com/MacHu-GWU/airflow_dag_artifact-project\n\n------\n\n.. .. image:: https://img.shields.io/badge/Link-Document-blue.svg\n    :target: https://airflow-dag-artifact.readthedocs.io/en/latest/\n\n.. .. image:: https://img.shields.io/badge/Link-API-blue.svg\n    :target: https://airflow-dag-artifact.readthedocs.io/en/latest/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n    :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n    :target: https://github.com/MacHu-GWU/airflow_dag_artifact-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n    :target: https://github.com/MacHu-GWU/airflow_dag_artifact-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n    :target: https://github.com/MacHu-GWU/airflow_dag_artifact-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n    :target: https://pypi.org/pypi/airflow-dag-artifact#files\n\n\nWelcome to ``airflow_dag_artifact`` Documentation\n==============================================================================\nA lot of serverless AWS Service supports versioning and alias for deployment. It made the blue / green deployment, canary deployment and rolling back super easy.\n\n- `AWS Lambda Versioning and Alias <https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html>`_\n- `AWS StepFunction Versioning and Alias <https://docs.aws.amazon.com/step-functions/latest/dg/auth-version-alias.html>`_\n- `AWS SageMaker Model Registry Versioning <https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry.html>`_\n\nHowever, Airflow DAG does not support this feature yet. This library provides a way to manage Airflow DAG versioning and alias so you can deploy Airflow DAG with confidence.\n\nPlease `read this tutorial <https://github.com/MacHu-GWU/airflow_dag_artifact-project/blob/main/examples/deploy_versioned_airflow_dag_artifacts.ipynb>`_ to learn how to use this library.\n\nIt also has native `AWS MWAA <https://aws.amazon.com/managed-workflows-for-apache-airflow/>`_ support for DAG deployment automation, with the DAG versioning manage, which is not official supported by Apache Airflow. Please `read this example <https://github.com/MacHu-GWU/airflow_dag_artifact-project/blob/main/examples/aws_mwaa.py>`_ to learn how to use this library with AWS MWAA.\n\n\n.. _install:\n\nInstall\n------------------------------------------------------------------------------\n\n``airflow_dag_artifact`` is released on PyPI, so all you need is to:\n\n.. code-block:: console\n\n    $ pip install airflow-dag-artifact\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n    $ pip install --upgrade airflow-dag-artifact\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Airflow Dag Artifact versioning and alias Management for blue/green, canary deployment, and roll back for production failure.",
    "version": "0.2.1",
    "project_urls": {
        "Download": "https://pypi.python.org/pypi/airflow_dag_artifact/0.2.1#downloads",
        "Homepage": "https://github.com/MacHu-GWU/airflow_dag_artifact-project"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "42ed1055f9290a30d9ea8487eb15c372cf74dba74e8350f4a7772512611e90e4",
                "md5": "d97f0d28bf80faa5ee911e0e41ff56e4",
                "sha256": "82a38a415e136d01774c45a99f34fb72e9532eed0b045923ec867b71c3252093"
            },
            "downloads": -1,
            "filename": "airflow_dag_artifact-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d97f0d28bf80faa5ee911e0e41ff56e4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 14107,
            "upload_time": "2023-07-13T01:12:26",
            "upload_time_iso_8601": "2023-07-13T01:12:26.108912Z",
            "url": "https://files.pythonhosted.org/packages/42/ed/1055f9290a30d9ea8487eb15c372cf74dba74e8350f4a7772512611e90e4/airflow_dag_artifact-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "066c578cc3cc4658d85f45e72f13e24185c7f986b908412d41c769f8c2b9ce5b",
                "md5": "065b8e0e7f92bd3de1eafeb864b8d26a",
                "sha256": "7496caa344c38a388b3094109b7c978e74fb8390cd3dc8705f6b50611562983f"
            },
            "downloads": -1,
            "filename": "airflow_dag_artifact-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "065b8e0e7f92bd3de1eafeb864b8d26a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 15022,
            "upload_time": "2023-07-13T01:12:27",
            "upload_time_iso_8601": "2023-07-13T01:12:27.634143Z",
            "url": "https://files.pythonhosted.org/packages/06/6c/578cc3cc4658d85f45e72f13e24185c7f986b908412d41c769f8c2b9ce5b/airflow_dag_artifact-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-13 01:12:27",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "MacHu-GWU",
    "github_project": "airflow_dag_artifact-project",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [
        {
            "name": "boto3",
            "specs": []
        },
        {
            "name": "s3pathlib",
            "specs": [
                [
                    "<",
                    "3.0.0"
                ],
                [
                    ">=",
                    "2.0.1"
                ]
            ]
        },
        {
            "name": "versioned",
            "specs": [
                [
                    ">=",
                    "0.4.2"
                ],
                [
                    "<",
                    "1.0.0"
                ]
            ]
        }
    ],
    "lcname": "airflow-dag-artifact"
}
        
Elapsed time: 0.10572s