Step by Step Guide to Building a BitBucket API Integration in Python

Introduction

Hey there, fellow dev! Ready to supercharge your workflow with BitBucket's API? Let's dive into building a robust integration using the awesome atlassian-python-api package. This guide will get you up and running in no time, so buckle up!

Prerequisites

First things first, let's make sure you're set up:

1. Ensure you've got Python installed (3.6+ recommended).
2. Install the atlassian-python-api package:

pip install atlassian-python-api

Easy peasy, right? Now we're cooking with gas!

Authentication

Time to get your hands on those sweet API credentials:

1. Head over to BitBucket and create an API key.
2. Now, let's initialize our BitBucket client:

from atlassian import Bitbucket

bitbucket = Bitbucket(
    url='https://api.bitbucket.org',
    username='your_username',
    password='your_api_key'
)

Boom! You're authenticated and ready to roll.

Basic Operations

Let's start with some bread-and-butter operations:

# Fetch repo info
repo_info = bitbucket.get_repo('workspace', 'repo_slug')

# List branches
branches = bitbucket.get_branches('workspace', 'repo_slug')

# Get commit history
commits = bitbucket.get_commits('workspace', 'repo_slug')

See how easy that was? You're already a BitBucket API wizard!

Working with Pull Requests

PRs are the lifeblood of collaboration. Let's manage them like a pro:

# Create a PR
new_pr = bitbucket.create_pull_request(
    'workspace',
    'repo_slug',
    'title',
    'source_branch',
    'destination_branch'
)

# Get PR details
pr_details = bitbucket.get_pull_request('workspace', 'repo_slug', 'pr_id')

# Merge a PR
bitbucket.merge_pull_request('workspace', 'repo_slug', 'pr_id')

Smooth as butter, right?

Managing Repository Content

Let's get our hands dirty with some content management:

# Create/update a file
bitbucket.update_file(
    'workspace',
    'repo_slug',
    'path/to/file',
    'file_content',
    'commit_message',
    'branch_name'
)

# Delete a file
bitbucket.delete_file(
    'workspace',
    'repo_slug',
    'path/to/file',
    'commit_message',
    'branch_name'
)

# Create a branch
bitbucket.create_branch(
    'workspace',
    'repo_slug',
    'branch_name',
    'start_point'
)

You're now a content ninja!

Advanced Features

Ready to level up? Let's tackle some advanced stuff:

# Set up a webhook
bitbucket.create_webhook(
    'workspace',
    'repo_slug',
    'webhook_url',
    events=['repo:push', 'pullrequest:created']
)

# Get build status
build_status = bitbucket.get_build_status('workspace', 'repo_slug', 'commit_hash')

# Manage team members
bitbucket.add_group_member('workspace', 'group_slug', 'user_uuid')

Look at you go! You're handling BitBucket like a champ.

Error Handling and Best Practices

Don't let those pesky errors catch you off guard:

from atlassian.errors import ApiError

try:
    repo_info = bitbucket.get_repo('workspace', 'repo_slug')
except ApiError as e:
    if e.status_code == 429:
        print("Whoa there! We've hit the rate limit. Time for a coffee break.")
    else:
        print(f"Oops! Something went wrong: {str(e)}")

Always handle your exceptions, folks. Your future self will thank you!

Testing and Debugging

Let's wrap this up with some testing goodness:

import unittest

class TestBitbucketIntegration(unittest.TestCase):
    def setUp(self):
        self.bitbucket = Bitbucket(url='https://api.bitbucket.org', username='test', password='test')

    def test_get_repo(self):
        repo = self.bitbucket.get_repo('workspace', 'repo_slug')
        self.assertIsNotNone(repo)

if __name__ == '__main__':
    unittest.main()

Pro tip: Use a dedicated test account to avoid any oopsies with your production data.

Conclusion

And there you have it! You've just built a rock-solid BitBucket API integration. From basic operations to advanced features, you're now equipped to automate your BitBucket workflows like a boss.

Remember, the atlassian-python-api docs are your best friend for diving deeper. Now go forth and code brilliantly!

Happy integrating, you magnificent developer, you!