Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jvrck/bb-ripper
Bitbucket Repo Ripper - Backup your Bitbucket repositories
https://github.com/jvrck/bb-ripper
backup bitbucket docker docker-image git python python3
Last synced: 28 days ago
JSON representation
Bitbucket Repo Ripper - Backup your Bitbucket repositories
- Host: GitHub
- URL: https://github.com/jvrck/bb-ripper
- Owner: jvrck
- License: mit
- Created: 2022-04-18T06:26:16.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-27T20:02:09.000Z (12 months ago)
- Last Synced: 2024-04-23T20:53:59.933Z (7 months ago)
- Topics: backup, bitbucket, docker, docker-image, git, python, python3
- Language: Python
- Homepage:
- Size: 43 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# bb-ripper - Bitbucket Repo Ripper
This project downloads all Bitbucket repositories and every branch for each repository. The resulting downloads are compressed with `tar`.
## Bitbucket Authentication
This application works with [Bitbucket App Passwords](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/)
## Environment Settings
The application requires the following environment variables to run.
`BB_USER` The username component of the Bitbucket App Password.
`BB_PASSWORD` The password component of the Bitbucket App Password.
`BB_WORKSPACE` The name of the Bitbucket workspace.
`BB_RIPPER_EXPORT_DIRECTORY` The path of the output.
With the optional environment variable `BB_TEST_COUNTER` you can pull down only a specified number of repositories. This is useful for testing purposes. All values that are non integer and lower that 1 will be ignored.
## Running the ripper
### Local Environment
The application was developed and tested on MacOS with the [Python 3.11 package](https://formulae.brew.sh/formula/[email protected]) managed with [Homebrew](https://brew.sh/).
To install Python dependencies
```bash
pip install -r requirements.txt
```
### Set the environment variables
To set the environment variables: Rename `env_setup.sh.example` to `env_setup.sh` after adding values for your environment, then source the environment variables to add them to your session.
```bash
source env_setup.sh
```
### Run
To run the application
```bash
cd bb-ripper
python3 .
```
### Running the docker image
To run the docker image: Create a Docker environment file with the variables required, named `docenv`. Create a directory named `data` to store the repositories. This directory will be mounted to the `/data` volume in the container.
The repository contains a file named `docenv.example` that is a template for the `docenv` file.
```bash
docker pull jvrck/bbripper
docker run --env-file dockenv -v $(pwd)/data:/data --rm -it jvrck/bbripper:latest
```
### Building and running the docker image
To build the docker image
```bash
docker build --no-cache -t ripper .
```
To run the image, create a docker environment file with the variables required named `docenv`. Create a directory named `data` to store the repositories. This directory will be mounted to the `/data` volume in the container.
```bash
docker run --env-file dockenv -v $(pwd)/data:/data --rm -it ripper:latest
```
## Docker image with AWS CLI
A variant of the image that has the AWS CLI preinstalled. This can be done during the build by passing a build argument to the Docker `build` command.
```bash
docker build --no-cache -t bbripper-aws --build-arg AWSCLI=TRUE .
```