https://github.com/ahuang11/prefect-for-testing
My personal sandbox for testing!
https://github.com/ahuang11/prefect-for-testing
Last synced: about 1 month ago
JSON representation
My personal sandbox for testing!
- Host: GitHub
- URL: https://github.com/ahuang11/prefect-for-testing
- Owner: ahuang11
- License: apache-2.0
- Created: 2023-01-04T19:11:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-27T14:21:09.000Z (about 2 years ago)
- Last Synced: 2025-01-24T19:12:14.752Z (3 months ago)
- Language: Python
- Size: 611 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# prefect-for-testing
Visit the full docs [here](https://ahuang11.github.io/prefect-for-testing) to see additional examples and the API reference.
## Welcome!
My personal sandbox for testing!
## 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](https://orion-docs.prefect.io/).
### Installation
Install `prefect-for-testing` with `pip`:
```bash
pip install prefect-for-testing
```
A list of available blocks in `prefect-for-testing` and their setup instructions can be found [here](https://ahuang11.github.io/prefect-for-testing/#blocks-catalog).
### Write and run a flow
```python
from prefect import flow
from prefect_for_testing.tasks import (
goodbye_prefect_for_testing,
hello_prefect_for_testing,
)
# Use `with_options` to customize options on any existing task or flow
custom_goodbye_prefect_for_testing = goodbye_prefect_for_testing.with_options(
name="My custom task name",
retries=2,
retry_delay_seconds=10,
)
@flow
def example_flow():
hello_prefect_for_testing
custom_goodbye_prefect_for_testing
example_flow()
```
For more tips on how to use tasks and flows in a Collection, check out [Using Collections](https://orion-docs.prefect.io/collections/usage/)!
## Resources
If you encounter any bugs while using `prefect-for-testing`, feel free to open an issue in the [prefect-for-testing](https://github.com/ahuang11/prefect-for-testing) repository.
If you have any questions or issues while using `prefect-for-testing`, you can find help in either the [Prefect Discourse forum](https://discourse.prefect.io/) or the [Prefect Slack community](https://prefect.io/slack).
Feel free to star or watch [`prefect-for-testing`](https://github.com/ahuang11/prefect-for-testing) for updates too!
## Contributing
If you'd like to help contribute to fix an issue or add a feature to `prefect-for-testing`, please [propose changes through a pull request from a fork of the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
Here are the steps:
1. [Fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository)
2. [Clone the forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository)
3. Install the repository and its dependencies:
```
pip install -e ".[dev]"
```
4. Make desired changes
5. Add tests
6. Insert an entry to [CHANGELOG.md](https://github.com/ahuang11/prefect-for-testing/blob/main/CHANGELOG.md)
7. Install `pre-commit` to perform quality checks prior to commit:
```
pre-commit install
```
8. `git commit`, `git push`, and create a pull request