prefect-client
The prefect-client package is a minimal-installation of prefect which is designed for interacting with Prefect Cloud
or remote any prefect server. It sheds some functionality and dependencies in exchange for a smaller installation size,
making it ideal for use in lightweight or ephemeral environments. These characteristics make it ideal for use in lambdas
or other resource-constrained environments.
Getting started
prefect-client shares the same installation requirements as prefect. To install, make sure you are on Python 3.10 or
later and run the following command:
pip install prefect-client
Next, ensure that your prefect-client has access to a remote prefect server by exporting the PREFECT_API_KEY
(if using Prefect Cloud) and PREFECT_API_URL environment variables. Once those are set, use the package in your code as
you would normally use prefect!
For example, to remotely trigger a run a deployment:
from prefect.deployments import run_deployment
def my_lambda(event):
...
run_deployment(
name="my-flow/my-deployment",
parameters={"foo": "bar"},
timeout=0,
)
my_lambda({})
To emit events in an event driven system:
from prefect.events import emit_event
def something_happened():
emit_event("my-event", resource={"prefect.resource.id": "foo.bar"})
something_happened()
Or just interact with a prefect API:
from prefect.client.orchestration import get_client
async def query_api():
async with get_client() as client:
limits = await client.read_concurrency_limits(limit=10, offset=0)
print(limits)
query_api()
Known limitations
By design, prefect-client omits all CLI and server components. This means that the CLI is not available for use
and attempts to access server objects will fail. Furthermore, some classes, methods, and objects may be available
for import in prefect-client but may not be "runnable" if they tap into server-oriented functionality. If you
encounter such a limitation, feel free to open an issue
describing the functionality you are interested in using and we will do our best to make it available.
Next steps
There's lots more you can do to orchestrate and observe your workflows with Prefect! Start with our friendly tutorial or explore the core concepts of Prefect workflows.
Join the community
Prefect is made possible by the fastest growing community of thousands of friendly data engineers. Join us in building a new kind of workflow system. The Prefect Slack community is a fantastic place to learn more about Prefect, ask questions, or get help with workflow design. All community forums, including code contributions, issue discussions, and Slack messages are subject to our Code of Conduct.
Contribute
See our documentation on contributing to Prefect.
Thanks for being part of the mission to build a new kind of workflow system and, of course, happy engineering!
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file prefect_client-3.8.0.tar.gz.
File metadata
- Download URL: prefect_client-3.8.0.tar.gz
- Upload date:
- Size: 919.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6b5e9b212be62ef05ddf93a68a501f6dba1cd3e067f6a36a62f1d2cf76bbd256
|
|
| MD5 |
cb673378534ea84b8f29865ca29c9b8c
|
|
| BLAKE2b-256 |
494bb844980f2fd16f67cee67fd5643df4c91b415e00cbec2b690603daa52393
|
Provenance
The following attestation bundles were made for prefect_client-3.8.0.tar.gz:
Publisher:
prefect-client-publish.yaml on PrefectHQ/prefect
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
prefect_client-3.8.0.tar.gz -
Subject digest:
6b5e9b212be62ef05ddf93a68a501f6dba1cd3e067f6a36a62f1d2cf76bbd256 - Sigstore transparency entry: 2228917696
- Sigstore integration time:
-
Permalink:
PrefectHQ/prefect@218fb46646bda2a229d74ce80c35dcf9baa2f0f3 -
Branch / Tag:
refs/tags/3.8.0 - Owner: https://github.com/PrefectHQ
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
prefect-client-publish.yaml@218fb46646bda2a229d74ce80c35dcf9baa2f0f3 -
Trigger Event:
release
-
Statement type:
File details
Details for the file prefect_client-3.8.0-py3-none-any.whl.
File metadata
- Download URL: prefect_client-3.8.0-py3-none-any.whl
- Upload date:
- Size: 1.1 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
da756c92fc5c2167b23f9b5fa159dae5e66e32006b30fbaa6d8b0058782053d1
|
|
| MD5 |
c81afb88efb0a39757c326ad675767d0
|
|
| BLAKE2b-256 |
c6129243782f06da4922e9618b1df9f73db173ee94ad44e81d30f1480c74dc71
|
Provenance
The following attestation bundles were made for prefect_client-3.8.0-py3-none-any.whl:
Publisher:
prefect-client-publish.yaml on PrefectHQ/prefect
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
prefect_client-3.8.0-py3-none-any.whl -
Subject digest:
da756c92fc5c2167b23f9b5fa159dae5e66e32006b30fbaa6d8b0058782053d1 - Sigstore transparency entry: 2228918203
- Sigstore integration time:
-
Permalink:
PrefectHQ/prefect@218fb46646bda2a229d74ce80c35dcf9baa2f0f3 -
Branch / Tag:
refs/tags/3.8.0 - Owner: https://github.com/PrefectHQ
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
prefect-client-publish.yaml@218fb46646bda2a229d74ce80c35dcf9baa2f0f3 -
Trigger Event:
release
-
Statement type:
