prefect-soda-cloud 0.0.1
Collection of Prefect tasks to interact with Soda Cloud APIs.
License: Apache License 2.0
Requires Python: >=3.8
Keywords: prefect

# prefect-soda-cloud

<p align="center">
    <!--- Insert a cover image here -->
    <!--- <br> -->
    <a href="https://pypi.python.org/pypi/prefect-soda-cloud/" alt="PyPI version">
        <img alt="PyPI" src="https://img.shields.io/pypi/v/prefect-soda-cloud?color=0052FF&labelColor=090422"></a>
    <a href="https://github.com/AlessandroLollo/prefect-soda-cloud/" alt="Stars">
        <img src="https://img.shields.io/github/stars/AlessandroLollo/prefect-soda-cloud?color=0052FF&labelColor=090422" /></a>
    <a href="https://pypistats.org/packages/prefect-soda-cloud/" alt="Downloads">
        <img src="https://img.shields.io/pypi/dm/prefect-soda-cloud?color=0052FF&labelColor=090422" /></a>
    <a href="https://github.com/AlessandroLollo/prefect-soda-cloud/pulse" alt="Activity">
        <img src="https://img.shields.io/github/commit-activity/m/AlessandroLollo/prefect-soda-cloud?color=0052FF&labelColor=090422" /></a>
    <br>
    <a href="https://prefect-community.slack.com" alt="Slack">
        <img src="https://img.shields.io/badge/slack-join_community-red.svg?color=0052FF&labelColor=090422&logo=slack" /></a>
    <a href="https://discourse.prefect.io/" alt="Discourse">
        <img src="https://img.shields.io/badge/discourse-browse_forum-red.svg?color=0052FF&labelColor=090422&logo=discourse" /></a>
</p>

Visit the full docs [here](https://AlessandroLollo.github.io/prefect-soda-cloud) to see additional examples and the API reference.

Collection of Prefect tasks to interact with Soda Cloud APIs.


<!--- ### Add a real-world example of how to use this Collection here

Offer some motivation on why this helps.

After installing `prefect-soda-cloud` and [saving the credentials](#saving-credentials-to-block), you can easily use it within your flows to help you achieve the aforementioned benefits!

```python
from prefect import flow, get_run_logger
```

--->

## Resources

For more tips on how to use tasks and flows in a Collection, check out [Using Collections](https://docs.prefect.io/collections/usage/)!

### Installation

Install `prefect-soda-cloud` with `pip`:

```bash
pip install prefect-soda-cloud
```

Requires an installation of Python 3.8+.

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://docs.prefect.io/).

### Examples
<!--- ### Saving credentials to block -->

Note, to use the `load` method on Blocks, you must already have a block document [saved through code](https://docs.prefect.io/concepts/blocks/#saving-blocks) or [saved through the UI](https://docs.prefect.io/ui/blocks/).

Below is an example on saving block documents through code.

```python title="save_soda_cloud_credentials_as_block.py"
from prefect_soda_cloud import SodaCloudCredentials

SodaCloudCredentials(
    user_or_api_key_id="<username or API key ID>",
    pwd_or_api_key_secret="<password or API key secret>"
).save("your_block_fancy_name")
```

```python title="save_soda_cloud_auth_config_as_block.py"
from prefect_soda_cloud import SodaCloudAuthConfig, SodaCloudCredentials

# Assuming you have already registered your Soda Cloud credentials in a block, you can load it
creds = SodaCloudCredentials.load("your_block_fancy_name")

SodaCloudAuthConfig(
    api_base_url="https://cloud.soda.io",
    creds=creds
).save("another_fancy_name")
```

!!! info "Registering blocks"

    Register blocks in this module to
    [view and edit them](https://docs.prefect.io/ui/blocks/)
    on Prefect Cloud:

    ```bash
    prefect block register -m prefect_soda_cloud
    ```

A list of available blocks in `prefect-soda-cloud` and their setup instructions can be found [here](./auth_config).

<!-- --->

### Feedback

If you encounter any bugs while using `prefect-soda-cloud`, feel free to open an issue in the [prefect-soda-cloud](https://github.com/AlessandroLollo/prefect-soda-cloud) repository.

If you have any questions or issues while using `prefect-soda-cloud`, 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-soda-cloud`](https://github.com/AlessandroLollo/prefect-soda-cloud) for updates too!

### Contributing

If you'd like to help contribute to fix an issue or add a feature to `prefect-soda-cloud`, 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/AlessandroLollo/prefect-soda-cloud/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