prefecthq / prefect-github Goto Github PK

View Code? Open in Web Editor NEW

31.0 11.0 2.0 4.84 MB

Prefect integrations for interacting with GitHub

Home Page: https://prefecthq.github.io/prefect-github/

License: Apache License 2.0

Python 100.00%

collection github prefect graphql schema

prefect-github's Introduction

prefect-github

Welcome!

Prefect integrations interacting with GitHub.

The tasks within this collection were created by a code generator using the GitHub GraphQL schema.

Getting Started

Python setup

Requires an installation of Python 3.8 or newer.

We recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.

These tasks are designed to work with Prefect 2. For more information about how to use Prefect, please refer to the Prefect documentation.

Installation

Install prefect-github with pip:

pip install prefect-github

Then, register to view the block on Prefect Cloud:

prefect block register -m prefect_github

Note, to use the load method on Blocks, you must already have a block document saved through code or saved through the UI.

Write and run a flow

from prefect import flow
from prefect_github import GitHubCredentials
from prefect_github.repository import query_repository
from prefect_github.mutations import add_star_starrable


@flow()
def github_add_star_flow():
    github_credentials = GitHubCredentials.load("github-token")
    repository_id = query_repository(
        "PrefectHQ",
        "Prefect",
        github_credentials=github_credentials,
        return_fields="id"
    )["id"]
    starrable = add_star_starrable(
        repository_id,
        github_credentials
    )
    return starrable


github_add_star_flow()

Resources

If you encounter any bugs while using prefect-github, feel free to open an issue in the prefect-github repository.

If you have any questions or issues while using prefect-github, you can find help in the Prefect Slack community.

Feel free to ⭐️ or watch prefect-github for updates too!

Development

If you'd like to install a version of prefect-github for development, clone the repository and perform an editable install with pip:

git clone https://github.com/PrefectHQ/prefect-github.git

cd prefect-github/

pip install -e ".[dev]"

# Install linting pre-commit hooks
pre-commit install

prefect-github's People

Contributors

Stargazers

Watchers

Forkers

tobiassteenweg coknowsys

prefect-github's Issues

Feature: support sparse checkout

On large mono repos, it may not be desirable to checkout the entire repo.

Using sparse checkout it's possible to just do a partial clone.

 command = f"""git clone \
                --depth 1 --sparse \
                --no-checkout \
                https://{secret_block.get()}@github.com/{ORG}/{REPO}.git; \
                cd {REPO} && \
                git checkout master && \
                git sparse-checkout set {sub_directory}
                """

I would imagine there would be an option to supply a sub-directory and if supplied the clone would work like the above

Add collection sync workflow using cruft

Add cruft to repo to allow synchronization of this collection with the original template.
Cruft can be added by running cruft link. Note that a starting commit will need to be specified.
Using the commit of the prefect-collection-template closest to the generation date of this repo
is a good default.

update docs to show flow code storage

docs don't currently show flow code storage example

Add collection sync workflow

    See:
    - PrefectHQ/prefect-great-expectations#21
    - https://github.com/PrefectHQ/prefect-great-expectations/blob/main/.cruft.json

┃ Registered Blocks  ┃
┡━━━━━━━━━━━━━━━━━━━━┩
│ GitHub Credentials │
│ GitHub Repository  │
└────────────────────┘

 To configure the newly 
registered blocks, go to 
the Blocks page in the 
Prefect UI: 
None/blocks/catalog