prefect bitbucket

Note

Active development of this project has moved within PrefectHQ/prefect. The code can be found here and documentation here. Please open issues and PRs against PrefectHQ/prefect instead of this repository.

prefect-bitbucket                     

Welcome!

Prefect integrations for working with Bitbucket repositories.

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-bitbucket with pip:

pip install prefect-bitbucket

Then, register to view the block on Prefect Cloud:

prefect block register -m prefect_bitbucket

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

Load a pre-existing BitBucketCredentials block

from prefect import flowfrom prefect_bitbucket.credentials import BitBucketCredentials@flowdef use_stored_bitbucket_creds_flow():bitbucket_credentials_block = BitBucketCredentials.load("BLOCK_NAME")return bitbucket_credentials_blockuse_stored_bitbucket_creds_flow()

Create a new BitBucketCredentials block in a flow

from prefect import flowfrom prefect_bitbucket.credentials import BitBucketCredentials@flowdef create_new_bitbucket_creds_flow():bitbucket_credentials_block = BitBucketCredentials(token="my-token",username="my-username")create_new_bitbucket_creds_flow()

Create a BitBucketRepository block for a public repo

from prefect_bitbucket import BitBucketRepositorypublic_repo = "https://bitbucket.org/my-workspace/my-repository.git"# Creates a public BitBucket repository BitBucketRepository blockpublic_bitbucket_block = BitBucketRepository(repository=public_repo)# Saves the BitBucketRepository block to your Prefect workspace (in the Blocks tab)public_bitbucket_block.save("my-bitbucket-block")

Create a BitBucketRepository block for a public repo at a specific branch or tag

from prefect_bitbucket import BitBucketRepositorypublic_repo = "https://bitbucket.org/my-workspace/my-repository.git"# Creates a public BitBucket repository BitBucketRepository blockbranch_bitbucket_block = BitBucketRepository(reference="my-branch-or-tag",  # e.g "master"repository=public_repo)# Saves the BitBucketRepository block to your Prefect workspace (in the Blocks tab)branch_bitbucket_block.save("my-bitbucket-branch-block")

Create a new BitBucketCredentials block and a BitBucketRepository block for a private repo

from prefect_bitbucket import BitBucketCredentials, BitBucketRepository# For a private repo, we need credentials to access itbitbucket_credentials_block = BitBucketCredentials(token="my-token",username="my-username"  # optional)# Saves the BitBucketCredentials block to your Prefect workspace (in the Blocks tab)bitbucket_credentials_block.save(name="my-bitbucket-credentials-block")# Creates a private BitBucket repository BitBucketRepository blockprivate_repo = "https://bitbucket.org/my-workspace/my-repository.git"private_bitbucket_block = BitBucketRepository(repository=private_repo,bitbucket_credentials=bitbucket_credentials_block)# Saves the BitBucketRepository block to your Prefect workspace (in the Blocks tab)private_bitbucket_block.save(name="my-private-bitbucket-block")

Use a preexisting BitBucketCredentials block to create a BitBucketRepository block for a private repo

from prefect_bitbucket import BitBucketCredentials, BitBucketRepository# Loads a preexisting BitBucketCredentials blockBitBucketCredentials.load("my-bitbucket-credentials-block")# Creates a private BitBucket repository BitBucketRepository blockprivate_repo = "https://bitbucket.org/my-workspace/my-repository.git"private_bitbucket_block = BitBucketRepository(repository=private_repo,bitbucket_credentials=bitbucket_credentials_block)# Saves the BitBucketRepository block to your Prefect workspace (in the Blocks tab)private_bitbucket_block.save(name="my-private-bitbucket-block")

!!! info "Differences between Bitbucket Server and Bitbucket Cloud"

For Bitbucket Cloud, only set the `token` to authenticate. For Bitbucket Server, set both the `token` and the `username`.

Resources

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

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

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

Development

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

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

pip install -e ".[dev]"# Install linting pre-commit hookspre-commit install