Add basic template that uses ImageSpec

README.md

@@ -1,9 +1,16 @@
 In this repository you'll find a collection of [cookiecutter](https://cookiecutter.readthedocs.io/en/latest/) templates for making [Flyte](https://github.com/flyteorg/flyte) projects.
 
-We use cookiecutter's ability to define [multiple templates to be defined in the same repository](https://cookiecutter.readthedocs.io/en/latest/advanced/directories.html). Each cookiecutter template is defined in a separate directory, e.g. the template used in Flyte's [Getting Started](https://docs.flyte.org/en/latest/getting_started.html) guide lives in a directory called `simple-example`.
+We use cookiecutter's ability to define [multiple templates to be defined in the same repository](https://cookiecutter.readthedocs.io/en/latest/advanced/directories.html). Each cookiecutter template is defined in a separate directory, e.g. the template used in Flyte's [Getting Started](https://docs.flyte.org/en/latest/getting_started.html) guide lives in a directory called `basic-example-imagespec`.
 
-This project includes a script `docker_build.sh` that you can use to build a
-Docker image for your Flyte project.
+## Images
+
+Compiled images for all templates can be found in our [ghcr.io registry](https://github.com/flyteorg/flytekit-python-template/pkgs/container/flytekit-python-template)
+
+### ImageSpec vs Dockerfile
+
+Flytekit uses the `basic-example-imagespec` template by default when you initialize a new project with `pyflyte init`. That template uses [ImageSpec](https://docs.flyte.org/projects/cookbook/en/latest/auto_examples/customizing_dependencies/image_spec.html#image-spec-example), which builds Docker images without a Dockerfile, so doesn't contain a Dockerfile or `docker-build.sh` script.
+
+However, some templates in this repository contain a Dockerfile and `docker-build.sh` script that you can use to build a Docker image for your Flyte project:
 
 ```
 # help
@@ -16,13 +23,12 @@ Docker image for your Flyte project.
 ./docker_build.sh -p {{ cookiecutter.project_name }} -r <REGISTRY> -v <VERSION>
 ```
 
-## Images
-Compiled Images for all templates can be found in our [ghcr.io registry](https://github.com/flyteorg/flytekit-python-template/pkgs/container/flytekit-python-template)
+**Note:** You should only use `docker-build.sh` script to build a Docker image for a Flyte project that contains a Dockerfile.
 
 ## Usage
 
-Each template can be rendered by specifying the `--directory` flag to cookiecutter. For example, in order to generate a project using the `simple-example` template run:
+Each template can be rendered by specifying the `--directory` flag to cookiecutter. For example, in order to generate a project using the `basic-example-imagespec` template, run:
 
-    $ cookiecutter https://github.com/flyteorg/flytekit-python-template.git --directory="simple-example"
+    $ cookiecutter https://github.com/flyteorg/flytekit-python-template.git --directory="basic-example-imagespec"
 
-This should prompt for a few variables that will be used to setup the project.
+This should prompt for a few variables that will be used to set up the project.

basic-template-imagespec/cookiecutter.json

@@ -0,0 +1,3 @@
+{
+    "project_name": "Basic template ImageSpec"
+}

basic-template-imagespec/{{cookiecuter.project_name}}/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed 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.

basic-template-imagespec/{{cookiecuter.project_name}}/README.md

@@ -0,0 +1,8 @@
+# {{ cookiecutter.project_name }}
+
+A template for the recommended layout of a Flyte enabled repository for code written in python using [flytekit](https://docs.flyte.org/projects/flytekit/en/latest/).
+
+## Usage
+
+To get up and running with your Flyte project, we recommend following the
+[Flyte getting started guide](https://docs.flyte.org/en/latest/getting_started.html).

basic-template-imagespec/{{cookiecuter.project_name}}/requirements.txt

@@ -0,0 +1 @@
+flytekit>=1.5.0

basic-template-imagespec/{{cookiecuter.project_name}}/workflows/example.py

@@ -0,0 +1,72 @@
+"""A basic Flyte project template that uses ImageSpec"""
+
+import typing
+from flytekit import task, workflow
+
+
+"""
+ImageSpec is a way to specify a container image configuration without a
+Dockerfile. To use ImageSpec:
+1. Add ImageSpec to the flytekit import line.
+2. Uncomment the ImageSpec definition below and modify as needed.
+3. If needed, create additional image definitions.
+4. Set the container_image parameter on tasks that need a specific image, e.g.
+`@task(container_image=basic_image)`. If no container_image is specified,
+flytekit will use the default Docker image at
+https://github.com/flyteorg/flytekit/pkgs/container/flytekit.
+
+For more information, see the
+`ImageSpec documentation <https://docs.flyte.org/projects/cookbook/en/latest/auto_examples/customizing_dependencies/image_spec.html#image-spec-example>`__.
+"""
+
+# image_definition = ImageSpec(
+#    name="flytekit",  # rename this to your docker image name
+#    base_image="ghcr.io/flyteorg/flytekit:py3.11-1.10.2",
+#    # the base image that flytekit will use to build your image
+#    packages=["flytekit>=1.6.0"],  # packages to add to the base image
+#    registry="ghcr.io/unionai-oss", # registry your image will be pushed to
+#    python_version="3.11"
+#    # the python version; optional if not different from the base image
+# )
+
+
+@task()
+def say_hello(name: str) -> str:
+    """A simple Flyte task to say "Hello".
+
+    The @task decorator allows Flyte to use this function as a Flyte task,
+    which is executed as an isolated, containerized unit of compute.
+    """
+    return f"Hello, {name}!"
+
+
+@task()
+def greeting_length(greeting: str) -> int:
+    """A task the counts the length of a greeting."""
+    return len(greeting)
+
+
+@workflow
+def wf(name: str = "world") -> typing.Tuple[str, int]:
+    """Declare workflow called `wf`.
+
+    The @workflow decorator defines an execution graph that is composed of
+    tasks and potentially sub-workflows. In this simple example, the workflow
+    is composed of just one task.
+
+    There are a few important things to note about workflows:
+    - Workflows are a domain-specific language (DSL) for creating execution
+      graphs and therefore only support a subset of Python's behavior.
+    - Tasks must be invoked with keyword arguments
+    - The output variables of tasks are Promises, which are placeholders for
+      values that are yet to be materialized, not the actual values.
+    """
+    greeting = say_hello(name=name)
+    greeting_len = greeting_length(greeting=greeting)
+    return greeting, greeting_len
+
+
+if __name__ == "__main__":
+    # Execute the workflow by invoking it like a function and passing in
+    # the necessary parameters
+    print(f"Running wf() {wf(name='passengers')}")

hello-world/cookiecutter.json

@@ -0,0 +1,3 @@
+{
+    "project_name": "Hello world"
+}

hello-world/{{cookiecutter.project_name}}/example.py

@@ -0,0 +1,20 @@
+"""A basic Flyte example"""
+
+from flytekit import task, workflow
+
+
+@task
+def say_hello(name: str) -> str:
+    return f"Hello, {name}!"
+
+
+@workflow
+def hello_world_wf(name: str = 'world') -> str:
+    res = say_hello(name=name)
+    return res
+
+
+if __name__ == "__main__":
+    # Execute the workflow by invoking it like a function and passing in
+    # the necessary parameters
+    print(f"Running wf() {hello_world_wf(name='passengers')}")

templates.json

@@ -2,5 +2,7 @@
   {"template_name":  "mnist-training", "workflow_name":  "mnist_workflow_cpu"},
   {"template_name":  "mnist-training", "workflow_name": "mnist_workflow_gpu"},
   {"template_name": "simple-example", "workflow_name": "wf"},
-  {"template_name":  "wine-classification", "workflow_name":  "training_workflow"}
+  {"template_name":  "wine-classification", "workflow_name":  "training_workflow"},
+  {"template_name":  "basic-template-imagespec", "workflow_name":  "wf"},
+  {"template_name":  "hello_world", "workflow_name": "hello_world_wf"}
 ]