Skip to main content

Package for easily deploying to Prefect Cloud.

Project description

prefect-cloud

:zap: Deploy your code to Prefect Cloud in seconds! :zap:

Deploy and run your Python functions on Prefect Cloud with a single command.

Installation

First, install uv if you haven't already. See installation docs here

curl -LsSf https://astral.sh/uv/install.sh | sh

Create and activate a virtual environment:

uv venv && source .venv/bin/activate

Then install prefect-cloud:

uv pip install prefect-cloud

Alternatively, you can run prefect-cloud as a tool without installing it using uvx. See uv tools guide for more details.

Login to Prefect Cloud

prefect-cloud login

Deploy your workflow

Deploy any Python function from a GitHub repository. For example:

# https://github.com/ExampleOwner/example-repo-cloud/blob/main/examples/hello.py

def hello_world():
    print("Hello, World!")

Deploy to Prefect Cloud

prefect-cloud deploy <path/to/file.py:function_name> --from <source repo URL>

e.g.

prefect-cloud deploy examples/hello.py:hello_world --from PrefectHQ/prefect-cloud

Run it with

prefect-cloud run <flow_name>/<deployment_name>

e.g.

prefect-cloud run hello_world/hello_world

Schedule it with

prefect-cloud schedule <flow_name>/<deployment_name> <SCHEDULE>

e.g.

prefect-cloud schedule hello_world/hello_world "0 * * * *"

Additional Options

Add Dependencies

# Add dependencies
prefect-cloud deploy ... --with pandas --with numpy

# Or install from requirements file at runtime
prefect-cloud deploy ... --with-requirements </path/to/requirements.txt>

Include Environment Variables

prefect-cloud deploy ... --env KEY=VALUE --env KEY2=VALUE2

** Include Secrets as Environment Variables**

prefect-cloud deploy ... --secret KEY=VALUE --secret KEY2=VALUE2

From a Private Repository

(Recommended!) Install the Prefect Cloud GitHub App into the repository you want to deploy from. This will allow you to deploy from private repositories without needing to provide a personal access token.

prefect-cloud github setup

Alternatively, you can provide a personal access token on each deploy:

prefect-cloud deploy ... --from <private source repo URL> --credentials GITHUB_TOKEN

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

prefect_cloud-0.1.4.tar.gz (102.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

prefect_cloud-0.1.4-py3-none-any.whl (48.5 kB view details)

Uploaded Python 3

File details

Details for the file prefect_cloud-0.1.4.tar.gz.

File metadata

  • Download URL: prefect_cloud-0.1.4.tar.gz
  • Upload date:
  • Size: 102.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.6.12

File hashes

Hashes for prefect_cloud-0.1.4.tar.gz
Algorithm Hash digest
SHA256 a3ca232d1fffed707c110a000dff79dffcbe96b3ea4b23e7b8dd86663f3c13d1
MD5 5a5b0daa444308c476be6883e53874ca
BLAKE2b-256 4bea98446f9593a563752e920d25e50f64fa8ebf84b682a29ba4ba614ea134ad

See more details on using hashes here.

File details

Details for the file prefect_cloud-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for prefect_cloud-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a7af0749a56193d9a670f31e8b81dc6f60a88d12bef8d5835cde2e4ca170f5a0
MD5 e4350c64b14d78fd50632e76ccab2d6b
BLAKE2b-256 b37d16d7edbf37318fc802ab48b6b40645583daa3467a4d7007e91a9f9d01813

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page