bqup 0.0.5

BigQuery backup scripts

# bqup

BigQuery backup scripts

## Dependencies

1. [Python BigQuery Client Library](https://cloud.google.com/bigquery/docs/reference/libraries#client-libraries-usage-python)

## Usage

```
Usage:
bqup [-p PROJECT_ID] [-d TARGET_DIR] [-fvx]

Options:
-p PROJECT_ID, --project PROJECT_ID Project ID to load. If unspecified, defaults to current project in configuration.
-d TARGET_DIR, --dir TARGET_DIR The target directory where the project will be written. Defaults to current timestamp.
-f --force Overwrite target directory if it exists.
-v --verbose Print a summary of the loaded project.
-x --schema Export table schemata as json.
```

## Development

1. Set up `gcloud` to run with your personal account (aka run with scissors)
1. Set up [application-default](https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login): `gcloud auth application-default login`
1. Install wheel: `pip3 install wheel`
1. Install `bqup` with `pip3 install -e .` (or `python3 setup.py develop`)
1. Run `bqup` (see [Usage](#usage))

## Production

**Note: When deploying for a new GCP project, consider using [Cloud Scheduler](https://cloud.google.com/scheduler/)**

1. Turn off your host Google Instance.
1. Enable BigQuery on the instance's Cloud API Access Scopes
1. Start the instance.
1. `ssh` into the Google Instance you want to run `bqup` from.
1. Authorize your Compute Instance Account to read from the target BigQuery project.
1. Install `bqup` by cloning this repo and running `pip3 install --user -e .` inside the repo.
1. Run `bqup`
- If it still doesn't work, check in IAM that the service account you are using has BigQuery read access.

### Setting up regular backups

1. On the machine that will run your backups, set up your git config (username, email, the usual).
1. Make a directory to use as the Git repository. For this example, let's use `repo`:

```
mkdir repo
cd repo
git init
```

1. Add the remote to the git repository (ideally a GCP repository). For this example, let's use `google`:

```
git remote add google <url-to-remote-repository>
```

1. Create a script called `bqup.sh` that follows the following template. For our example, our repository is dedicated to backups, so we just assume that our `HEAD` is the latest and just push gently to `master`.

```
#!/bin/bash
<path-to-bqup> -p <project-id> -d <path-to-repo>/projects -fv >> <path-to-log-file>
cd <path-to-repo>
date > last-updated.log
git add .
git commit -m "Automated bqup"
git push <remote> <branch>
```

1. Add this script to your [crontab](https://awc.com.my/uploadnew/5ffbd639c5e6eccea359cb1453a02bed_Setting%20Up%20Cron%20Job%20Using%20crontab.pdf) to run as frequently as your heart desires.

## Distribution

- Rebuild the `dist` directory

```sh
rm -rf dist
python3 setup.py bdist_wheel
```

- Test upload (optional, needs account)

```sh
twine upload -u thinkdatasci --repository-url https://test.pypi.org/legacy/ dist/*
```

- Final upload

```sh
twine upload -u thinkdatasci dist/*
```

## Policies

### Maintenance

#### Disclaimers

bqup is maintained on a **best effort** basis:

- No amount of official time is currently being dedicated to the regular
maintenance of this project.
- Thinking Machines does not make any guarantees about the quality of the
software.

#### Maintainers

The official maintainers in charge of responding to issues and merging pull
requests are:

- Primary:
- [Pepe Bawagan](https://github.com/syk0saje)
- Secondary:
- [Mark Steve Samson](https://github.com/marksteve)
- [Carlson Cheng](https://github.com/crcheng)

### Contribution

A list is maintained for all external contributors who have submitted pull
requests that were subsequently approved. Users are allowed and encouraged to
fork the project and submit pull requests and issues. All contributions must
adhere to these guidelines:

- [Commit messages](https://chris.beams.io/posts/git-commit/)
- [Github flow](https://guides.github.com/introduction/flow/)

Thinking Machines reserves the rights to:

- refuse to resolve issues
- close issues without resolution
- request changes to pull requests
- reject pull requests outright