Prefect collection of tasks and subflows to integrate with AWS
Project description
prefect-aws
Welcome!
prefect-aws is a collection of pre-built Prefect tasks that can be used to quickly construct Prefect flows that interact with Amazon Web Services.
Getting Started
Python setup
Requires an installation of Python 3.7+
We recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.
These tasks are designed to work with Prefect 2.0. For more information about how to use Prefect, please refer to the Prefect documentation.
Installation
Install prefect-aws
pip install prefect-aws
Then, register to view the block on Prefect Cloud:
prefect block register -m prefect_aws.credentials
Note, to use the load method on Blocks, you must already have a block document saved through code or saved through the UI.
AWS Authentication
You will need to obtain AWS credentials in order to use these tasks. Refer to the AWS documentation for authentication methods available.
Write and run a flow with prefect-aws tasks
from prefect import flow
from prefect_aws import AwsCredentials
from prefect_aws.s3 import s3_upload
@flow
def example_s3_upload_flow():
aws_credentials = AwsCredentials(
aws_access_key_id="acccess_key_id",
aws_secret_access_key="secret_access_key"
)
with open("data.csv", "rb") as file:
key = s3_upload(
bucket="bucket",
key="data.csv",
data=file.read(),
aws_credentials=aws_credentials,
)
example_s3_upload_flow()
Write and run a flow with AwsCredentials and S3Bucket
import asyncio
from prefect import flow
from prefect_aws import AwsCredentials
from prefect_aws.s3 import S3Bucket
@flow
async def aws_s3_bucket_roundtrip():
# create an AwsCredentials block here or through UI
aws_creds = AwsCredentials(
aws_access_key_id="AWS_ACCESS_KEY_ID",
aws_secret_access_key="AWS_SECRET_ACCESS_KEY"
)
s3_bucket = S3Bucket(
bucket_name="bucket", # must exist
aws_credentials=aws_creds,
basepath="subfolder",
)
key = await s3_bucket.write_path("data.csv", content=b"hello")
return await s3_bucket.read_path(key)
asyncio.run(aws_s3_bucket_roundtrip())
Write and run an async flow by loading a MinIOCredentials block to use in S3Bucket
import asyncio
from prefect import flow
from prefect_aws import MinIOCredentials
from prefect_aws.s3 import S3Bucket
@flow
async def minio_s3_bucket_roundtrip():
minio_creds = MinIOCredentials.load("MY_BLOCK_NAME")
s3_bucket = S3Bucket(
bucket_name="bucket", # must exist
minio_credentials=minio_creds,
endpoint_url="http://localhost:9000"
)
path_to_file = await s3_bucket.write_path("/data.csv", content=b"hello")
return await s3_bucket.read_path(path_to_file)
asyncio.run(minio_s3_bucket_roundtrip())
Next steps
Refer to the API documentation in the side menu to explore all the capabilities of Prefect AWS!
Resources
If you encounter and bugs while using prefect-aws, feel free to open an issue in the prefect-aws repository.
If you have any questions or issues while using prefect-aws, you can find help in either the Prefect Discourse forum or the Prefect Slack community
Feel free to ⭐️ or watch prefect-aws for updates too!
Development
If you'd like to install a version of prefect-aws for development, first clone the repository and then perform an editable install with pip:
git clone https://github.com/PrefectHQ/prefect-aws.git
cd prefect-aws/
pip install -e ".[dev]"
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for prefect_aws-0.1.7-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ee25efc1056040990b8785d77171e8400733a003610ca4cfd2c98b420c2fa000 |
|
| MD5 | d3acfbd081061a03bda37f817948cd69 |
|
| BLAKE2b-256 | bd1b54de08847af4f753f90576c47df52a95d27ea175bed2a5b8aa0983cd631a |
