Skip to content

Commit

Permalink
Move Docker Provider to the New Structure (apache#46097)
Browse files Browse the repository at this point in the history
* Move Docker Provider to the New Structure

* Fix test related to checking provider examples

* Fix taskflow.rst docker example path
  • Loading branch information
bugraoz93 authored Jan 30, 2025
1 parent baf54a8 commit 3919efc
Show file tree
Hide file tree
Showing 49 changed files with 623 additions and 55 deletions.
5 changes: 1 addition & 4 deletions .github/boring-cyborg.yml
Original file line number Diff line number Diff line change
Expand Up @@ -172,10 +172,7 @@ labelPRBasedOnFilePath:
- providers/discord/**

provider:docker:
- providers/src/airflow/providers/docker/**/*
- docs/apache-airflow-providers-docker/**/*
- providers/tests/docker/**/*
- providers/tests/system/docker/**/*
- providers/docker/**

provider:edge:
- providers/edge/**
Expand Down
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ apache-airflow-providers-common-io
apache-airflow-providers-common-sql
apache-airflow-providers-datadog
apache-airflow-providers-discord
apache-airflow-providers-docker
apache-airflow-providers-edge
apache-airflow-providers-exasol
apache-airflow-providers-facebook
Expand Down
25 changes: 0 additions & 25 deletions docs/apache-airflow-providers-docker/changelog.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/apache-airflow/tutorial/taskflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ Below is an example of using the ``@task.docker`` decorator to run a Python task

.. _taskflow/docker_example:

.. exampleinclude:: /../../providers/tests/system/docker/example_taskflow_api_docker_virtualenv.py
.. exampleinclude:: /../../providers/docker/tests/system/docker/example_taskflow_api_docker_virtualenv.py
:language: python
:dedent: 4
:start-after: [START transform_docker]
Expand Down
82 changes: 82 additions & 0 deletions providers/docker/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@

.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
.. http://www.apache.org/licenses/LICENSE-2.0
.. Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
.. NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN!
.. IF YOU WANT TO MODIFY TEMPLATE FOR THIS FILE, YOU SHOULD MODIFY THE TEMPLATE
`PROVIDER_README_TEMPLATE.rst.jinja2` IN the `dev/breeze/src/airflow_breeze/templates` DIRECTORY
Package ``apache-airflow-providers-docker``

Release: ``4.0.0``


`Docker <https://www.docker.com/>`__


Provider package
----------------

This is a provider package for ``docker`` provider. All classes for this provider package
are in ``airflow.providers.docker`` python package.

You can find package information and changelog for the provider
in the `documentation <https://airflow.apache.org/docs/apache-airflow-providers-docker/4.0.0/>`_.

Installation
------------

You can install this package on top of an existing Airflow 2 installation (see ``Requirements`` below
for the minimum Airflow version supported) via
``pip install apache-airflow-providers-docker``

The package supports the following python versions: 3.9,3.10,3.11,3.12

Requirements
------------

================== ==================
PIP package Version required
================== ==================
``apache-airflow`` ``>=2.9.0``
``docker`` ``>=7.1.0``
``python-dotenv`` ``>=0.21.0``
================== ==================

Cross provider package dependencies
-----------------------------------

Those are dependencies that might be needed in order to use all the features of the package.
You need to install the specified provider packages in order to use them.

You can install such cross-provider dependencies when installing from PyPI. For example:

.. code-block:: bash
pip install apache-airflow-providers-docker[common.compat]
================================================================================================================== =================
Dependent package Extra
================================================================================================================== =================
`apache-airflow-providers-common-compat <https://airflow.apache.org/docs/apache-airflow-providers-common-compat>`_ ``common.compat``
================================================================================================================== =================

The changelog for the provider package can be found in the
`changelog <https://airflow.apache.org/docs/apache-airflow-providers-docker/4.0.0/changelog.html>`_.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ ulimits
Usage Example
-------------

.. exampleinclude:: /../../providers/tests/system/docker/example_taskflow_api_docker_virtualenv.py
.. exampleinclude:: /../../providers/docker/tests/system/docker/example_taskflow_api_docker_virtualenv.py
:language: python
:start-after: [START transform_docker]
:end-before: [END transform_docker]
File renamed without changes.
File renamed without changes
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -73,19 +73,14 @@ versions:
- 1.0.1
- 1.0.0

dependencies:
- apache-airflow>=2.9.0
- docker>=7.1.0
- python-dotenv>=0.21.0

integrations:
- integration-name: Docker
external-doc-url: https://docs.docker.com/
logo: /integration-logos/docker/Docker.png
logo: /docs/integration-logos/Docker.png
tags: [software]
- integration-name: Docker Swarm
external-doc-url: https://docs.docker.com/engine/swarm/
logo: /integration-logos/docker/Docker-Swarm.png
logo: /docs/integration-logos/Docker-Swarm.png
tags: [software]

operators:
Expand Down
86 changes: 86 additions & 0 deletions providers/docker/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

# NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN!

# IF YOU WANT TO MODIFY THIS FILE EXCEPT DEPENDENCIES, YOU SHOULD MODIFY THE TEMPLATE
# `pyproject_TEMPLATE.toml.jinja2` IN the `dev/breeze/src/airflow_breeze/templates` DIRECTORY
[build-system]
requires = ["flit_core==3.10.1"]
build-backend = "flit_core.buildapi"

[project]
name = "apache-airflow-providers-docker"
version = "4.0.0"
description = "Provider package apache-airflow-providers-docker for Apache Airflow"
readme = "README.rst"
authors = [
{name="Apache Software Foundation", email="[email protected]"},
]
maintainers = [
{name="Apache Software Foundation", email="[email protected]"},
]
keywords = [ "airflow-provider", "docker", "airflow", "integration" ]
classifiers = [
"Development Status :: 5 - Production/Stable",
"Environment :: Console",
"Environment :: Web Environment",
"Intended Audience :: Developers",
"Intended Audience :: System Administrators",
"Framework :: Apache Airflow",
"Framework :: Apache Airflow :: Provider",
"License :: OSI Approved :: Apache Software License",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Topic :: System :: Monitoring",
]
requires-python = "~=3.9"

# The dependencies should be modified in place in the generated file
# Any change in the dependencies is preserved when the file is regenerated
dependencies = [
"apache-airflow>=2.9.0",
"docker>=7.1.0",
"python-dotenv>=0.21.0",
]

# The optional dependencies should be modified in place in the generated file
# Any change in the dependencies is preserved when the file is regenerated
[project.optional-dependencies]
"common.compat" = [
"apache-airflow-providers-common-compat"
]

[project.urls]
"Documentation" = "https://airflow.apache.org/docs/apache-airflow-providers-docker/4.0.0"
"Changelog" = "https://airflow.apache.org/docs/apache-airflow-providers-docker/4.0.0/changelog.html"
"Bug Tracker" = "https://github.com/apache/airflow/issues"
"Source Code" = "https://github.com/apache/airflow"
"Slack Chat" = "https://s.apache.org/airflow-slack"
"Twitter" = "https://x.com/ApacheAirflow"
"YouTube" = "https://www.youtube.com/channel/UCSXwxpWZQ7XZ1WL3wqevChA/"

[project.entry-points."apache_airflow_provider"]
provider_info = "airflow.providers.docker.get_provider_info:get_provider_info"

[tool.flit.module]
name = "airflow.providers.docker"

[tool.pytest.ini_options]
ignore = "tests/system/"
Loading

0 comments on commit 3919efc

Please sign in to comment.