Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Core feature] Automate generation of flyte-ready python projects #1799

Closed
2 tasks done
eapolinario opened this issue Nov 4, 2021 · 0 comments
Closed
2 tasks done
Assignees
Labels
enhancement New feature or request flytekit FlyteKit Python related issue
Milestone

Comments

@eapolinario
Copy link
Contributor

Motivation: Why do you think this is important?

The very first thing we ask users to do in our Getting started docs is to clone a repo and start making edits to the files in the local copy of that repo. This is less than ideal, instead we should streamline the initial experience and provide an automated way to generate the boilerplate code necessary to run flyte workflows, locally or otherwise.

Goal: What should the final outcome look like, ideally?

The idea of this feature is to provide a command that will be used to generate the boilerplate structure for flyte-ready projects with inputs provided by the user. This could command can be extended to cover a variety of scaffolding for projects, including examples that use GPUs or specific libraries (e.g. a pytorch-enabled project).

Describe alternatives you've considered

https://pypi.python.org/pypi/PasteScript/ - too complicated for our use case
https://pypi.org/project/Voodoo/ - the featureset seems adequate for this feature, but the project appears to be abandoned
https://github.com/copier-org/copier - API is similar to cookiecutter

Propose: Link/Inline OR Additional context

Implement a new pyflyte command that under the covers uses several cookiecutter templates.

The command will be called pyflyte init and initially it'll contain only one sub-command called example, which will correspond to the code used in our getting started docs.

As stated in the goal, the idea is to expand the init command to expose a variety of projects.

Are you sure this issue hasn't been raised already?

  • Yes

Have you read the Code of Conduct?

  • Yes
@eapolinario eapolinario added enhancement New feature or request untriaged This issues has not yet been looked at by the Maintainers labels Nov 4, 2021
@eapolinario eapolinario added this to the 0.18.1 milestone Nov 4, 2021
@eapolinario eapolinario self-assigned this Nov 4, 2021
@eapolinario eapolinario added the flytekit FlyteKit Python related issue label Nov 4, 2021
@eapolinario eapolinario removed the untriaged This issues has not yet been looked at by the Maintainers label Nov 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request flytekit FlyteKit Python related issue
Projects
None yet
Development

No branches or pull requests

1 participant