File: README

package info (click to toggle)
python-bitbucket-api 0.5.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 128 kB
  • sloc: python: 661; makefile: 4
file content (33 lines) | stat: -rw-r--r-- 1,232 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
#BitBucket-API

[![Build Status](https://secure.travis-ci.org/Sheeprider/BitBucket-api.png)](http://travis-ci.org/Sheeprider/BitBucket-api)

BitBucket-api is an ISC Licensed library, written in Python.

Bitbucket has a REST API publicly available, this package provide methods to interact with it.
It allows you to access most repositories, services (hooks) and ssh keys related functionalities.

##Features

* Access public user informations
* Access public or private repositories, tags or branches
* Create, update or delete one of your repository
* Access, create, update or delete a service (hook)
* Access, create or delete an SSH key
* Download a repository as an archive
* Access, create, update or delete an issue
* Access, create, update or delete an issue comment

##Installation

To install bitbucket-api, simply:

	$ pip install bitbucket-api


##Requirements

Bitbucket-api require [requests](https://github.com/kennethreitz/requests), [sh](https://github.com/amoffat/sh) and [requests-oauthlib](https://github.com/requests/requests-oauthlib)to work, but dependencies should be handled by pip.

##Documentation
Documentation is available on [Read The Docs](https://bitbucket-api.readthedocs.org/en/latest/index.html).