Skip to content

Commit

Permalink
Update "Creating a Flyte project" with link to new Dockerfile project…
Browse files Browse the repository at this point in the history
… template (#5215)

* update with link to dockerfile template

Signed-off-by: nikki everett <[email protected]>

* fix 404 error

Signed-off-by: nikki everett <[email protected]>

---------

Signed-off-by: nikki everett <[email protected]>
  • Loading branch information
neverett authored Apr 11, 2024
1 parent 9955256 commit 734d6f3
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,17 @@ conda activate flyte-example

Next, initialize your Flyte project. The [flytekit-python-template GitHub repository](https://github.com/flyteorg/flytekit-python-template) contains Flyte project templates with sample code that you can run as is or modify to suit your needs.

In this example, we will initialize the [basic-example-imagespec project template](https://github.com/flyteorg/flytekit-python-template/tree/main/basic-example-imagespec).
In this example, we will initialize the [basic-template-imagespec project template](https://github.com/flyteorg/flytekit-python-template/tree/main/basic-template-imagespec).

```{prompt} bash $
pyflyte init my_project
```

:::{note}

To initialize a Flyte project with a different template, use the `--template` parameter:
If you need to use a Dockerfile for your project, you can initialize the Dockerfile template:

`pyflyte init --template hello-world hello-world`
`pyflyte init --template basic-template-dockerfile my_project`
:::

### 3. Install additional requirements
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(flyte_project_components)=
# Flyte project components

A Flyte project is a directory containing task and workflow code, internal Python source code, configuration files, and other artifacts required to package up your code so that it can be run on a Flyte cluster.
Expand Down Expand Up @@ -26,13 +27,13 @@ You can specify pip-installable Python dependencies in your project by adding th
`requirements.txt` file.

```{note}
We recommend using [pip-compile](https://pip-tools.readthedocs.io/en/latest/) to
We recommend using [pip-compile](https://pip-tools.readthedocs.io/en/stable/) to
manage your project's Python requirements.
```

````{dropdown} See requirements.txt
```{rli} https://raw.githubusercontent.com/flyteorg/flytekit-python-template/main/simple-example/%7B%7Bcookiecutter.project_name%7D%7D/requirements.txt
```{rli} https://raw.githubusercontent.com/flyteorg/flytekit-python-template/main/basic-template-imagespec/%7B%7Bcookiecutter.project_name%7D%7D/requirements.txt
:caption: requirements.txt
```
Expand Down

0 comments on commit 734d6f3

Please sign in to comment.