Skip to content

Commit 0617300

Browse files
committed
Docs:
- Added bitbucket module docs
1 parent a2f0455 commit 0617300

File tree

2 files changed

+84
-0
lines changed

2 files changed

+84
-0
lines changed

docs/bitbucket.rst

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
Bitbucket module
2+
================
3+
4+
Manage projects
5+
---------------
6+
7+
.. code-block:: python
8+
9+
# Project list
10+
bitbucket.project_list()
11+
12+
# Project info
13+
bitbucket.project(key)
14+
15+
# Get users who has permission in project
16+
bitbucket.project_users(key, limit=99999)
17+
18+
# Get project administrators for project
19+
butbucket.project_users_with_administrator_permissions(key)
20+
21+
# Get Project Groups
22+
bitbucket.project_groups(key, limit=99999)
23+
24+
# Get groups with admin permissions
25+
bitbucket.project_groups_with_administrator_permissions(key)
26+
27+
# Project summary
28+
butbucket.project_summary(key)
29+
30+
Groups and admins
31+
-----------------
32+
33+
.. code-block:: python
34+
35+
# Get group of members
36+
bitbucket.group_members(group, limit=99999)
37+
38+
# All project administrators
39+
bitbucket.all_project_administrators()
40+
41+
Manage code
42+
-----------
43+
44+
.. code-block:: python
45+
46+
# Get repositories list from project
47+
bitbucket.repo_list(project_key, limit=25)
48+
49+
# Get branches from repo
50+
bitbucket.get_branches(project, repository, filter='', limit=99999, details=True)
51+
52+
# Delete branch from related repo
53+
bitbucket.delete_branch(project, repository, name, end_point)
54+
55+
# Get pull requests
56+
bitbucket.get_pull_requests(project, repository, state='OPEN', order='newest', limit=100, start=0)
57+
58+
# Get tags for related repo
59+
bitbucket.get_tags(project, repository, filter='', limit=99999)
60+
61+
# Get project tags
62+
# The authenticated user must have REPO_READ permission for the context repository to call this resource
63+
bitbucket.get_project_tags(project, repository, tag_name)
64+
65+
# Set tag
66+
# The authenticated user must have REPO_WRITE permission for the context repository to call this resource
67+
bitbucket.set_tag(project, repository, tag_name, commit_revision, description=None)
68+
69+
# Delete tag
70+
# The authenticated user must have REPO_WRITE permission for the context repository to call this resource
71+
bitbucket.delete_tag(project, repository, tag_name)
72+
73+
# Get diff
74+
bitbucket.get_diff(project, repository, path, hash_oldest, hash_newest)
75+
76+
# Get commit list from repo
77+
bitbucket.get_commits(project, repository, hash_oldest, hash_newest, limit=99999)
78+
79+
# Get change log between 2 refs
80+
bitbucket.get_changelog(project, repository, ref_from, ref_to, limit=99999)
81+
82+
# Get raw content of the file from repo
83+
bitbucket.get_content_of_file(project, repository, filename)

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Add a connection:
4242

4343
jira
4444
confluence
45+
bitbucket
4546

4647
.. |Build Status| image:: https://travis-ci.org/AstroMatt/atlassian-python-api.svg?branch=master
4748
:target: https://pypi.python.org/pypi/atlassian-python-api

0 commit comments

Comments
 (0)