c2.recipe.bitbucketbk 1.0b1

This package is backupp repository from bitbucket.org

Requirement
================

This recipe supports Python 2.6+, because using 'json' module.


Information
================

- Code repository: https://bitbucket.org/cmscom/c2.recipe.bitbucketbk
- Questions and comments to [e-mail]
- Report bugs at https://bitbucket.org/cmscom/c2.recipe.bitbucketbk/issues


Simple usage
==============

Modify buildout.cfg ::

parts =
...
bitbucketbk

[bitbucketbk]
recipe = c2.recipe.bitbucketbk
username = xxxxxxxxxxxxx
password = xxxxxxxxxxxxxxxxxx
location = /backups
ignore_project =
xxxxxx1
xxxxxx2

Run the buildout ::

bin/buildout -N

You can use backup scripts ::

bin/bitbucketbk

You will see backups in `/backups`.



Cron job integration
===========================

For example ::

[backupcronjob]
recipe = z3c.recipe.usercrontab
times = 0 12 * * *
command = ${buildout:directory}/bin/bitbucketbk


TODO
=======

issues backup
------------------

- comment backup
- some of backup data
- adding color on Excel data, (eg. new is RED)
Detailed Documentation
**********************

Supported options
=================

The recipe supports the following options:

username
username of bitbucket.org

password
password of bitbucket.org

location
backup location
default : buckups

ignore_project
option
Listing project name, if do you have no backup project

Example usage
=============

We'll start by creating a buildout that uses the recipe::

>>> write('buildout.cfg',
... """
... [buildout]
... parts = bitbucketbk
...
... [bitbucketbk]
... recipe = c2.recipe.bitbucketbk
... username = %(username)s
... password = %(password)s
... location = %(location)s
... """ % { 'username' : 'value1', 'password' : 'value2', 'location' : 'value3'})

Running the buildout gives us::

>>> print 'start', system(buildout)
start...
Installing bitbucketbk.
Unused options for bitbucketbk: 'location' 'password' 'username'.
<BLANKLINE>


Backup
=============

Calling ``bin/bitbucketbk``

>>> import sys
>>> write('bin', 'bitbucketbk',
... "#!%s\nimport sys\nprint ' '.join(sys.argv[1:])" % sys.executable)
>>> dontcare = system('chmod u+x bin/bitbucketbk')

By default, backups are done in ``var/bitbucketbk``::

>>> print system('bin/bitbucketbk')
...

Contributors
************

Manabu TERADA, Author


Change history
**************

1.0b2 (2012-08-25)
----------------------

- Backup of issues by Excel data, but ignore comment yet
- Ignore Don't get repo, if main_branch is null for maybe change API spec which is `main_branch`. [Manabu TERADA]


1.0b1 (2012-01-17)
----------------------

- Adding property 'ignore_project' [Manabu TERADA]

1.0a2 (2012-01-08)
----------------------

- Don't get repo, if main_branch is null. [Manabu TERADA]

1.0a1 (2012-01-08)
---------------------

- Created recipe with ZopeSkel [Manabu TERADA]
- Created base function & supported hg only, (no supporting git yet) [Manabu TERADA]



Download
********