z-backup


Namez-backup JSON
Version 0.1.1 PyPI version JSON
download
home_pageNone
SummarySimple backup service
upload_time2024-10-04 06:20:11
maintainerNone
docs_urlNone
authorWenyu Zhao
requires_python<4.0,>=3.12
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Auto Backup Service

# Use as a docker compose service

Add the following to your compose.yml:

```yaml
services:
  # Other services...
  backup:
    image: wenyuzhao/backup:latest
    container_name: my-backup
    restart: always
    volumes:
      - ./path/to/your/data/folder:/backup/example
      - ./.creds.json:/.creds.json # Google cloud service account key file
    environment:
      - BACKUP_INTERVAL=daily-17:00 # Daily at 3:00 AM AEST
      - BUCKET=your-bucket-name # Alternatively, add a "bucket" field to .creds.json
```

_To trigger backup once immediately, run `docker compose run backup now`._

# Use as a command-line tool for one-time backup

Make sure there is a `creds.json` or `.creds.json` under either `$PWD` or `$HOME/.config/z-backup`

1. Install the executable: `pipx install z-backup`
2. Run `z-backup ./path/to/your/data/folder`

# Push New Image

```bash
docker buildx build --push --platform linux/arm64,linux/amd64 --tag wenyuzhao/backup:latest .
```
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "z-backup",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.12",
    "maintainer_email": null,
    "keywords": null,
    "author": "Wenyu Zhao",
    "author_email": "wenyuzhaox@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/12/51/b6e2120ec7699ac0b3c071355bf16c1d46c82360b1ddc8faa6a55b35d53a/z_backup-0.1.1.tar.gz",
    "platform": null,
    "description": "# Auto Backup Service\n\n# Use as a docker compose service\n\nAdd the following to your compose.yml:\n\n```yaml\nservices:\n  # Other services...\n  backup:\n    image: wenyuzhao/backup:latest\n    container_name: my-backup\n    restart: always\n    volumes:\n      - ./path/to/your/data/folder:/backup/example\n      - ./.creds.json:/.creds.json # Google cloud service account key file\n    environment:\n      - BACKUP_INTERVAL=daily-17:00 # Daily at 3:00 AM AEST\n      - BUCKET=your-bucket-name # Alternatively, add a \"bucket\" field to .creds.json\n```\n\n_To trigger backup once immediately, run `docker compose run backup now`._\n\n# Use as a command-line tool for one-time backup\n\nMake sure there is a `creds.json` or `.creds.json` under either `$PWD` or `$HOME/.config/z-backup`\n\n1. Install the executable: `pipx install z-backup`\n2. Run `z-backup ./path/to/your/data/folder`\n\n# Push New Image\n\n```bash\ndocker buildx build --push --platform linux/arm64,linux/amd64 --tag wenyuzhao/backup:latest .\n```",
    "bugtrack_url": null,
    "license": null,
    "summary": "Simple backup service",
    "version": "0.1.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fa1bdd417088ac760dc948e40d9436afd643ea7fc15dbe44f500adcb7508c7a0",
                "md5": "e2fdbe8da7c55f0b79b7cdf8858a45f5",
                "sha256": "001721f29b973c5021126d52400f38072f1c4a6dd10aaa93040c37de272e9799"
            },
            "downloads": -1,
            "filename": "z_backup-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e2fdbe8da7c55f0b79b7cdf8858a45f5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.12",
            "size": 4457,
            "upload_time": "2024-10-04T06:20:09",
            "upload_time_iso_8601": "2024-10-04T06:20:09.992459Z",
            "url": "https://files.pythonhosted.org/packages/fa/1b/dd417088ac760dc948e40d9436afd643ea7fc15dbe44f500adcb7508c7a0/z_backup-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1251b6e2120ec7699ac0b3c071355bf16c1d46c82360b1ddc8faa6a55b35d53a",
                "md5": "d4b4d0283ad41e554402c4dba4a23f74",
                "sha256": "ae3dcbbb184982b438e7cca6c8fe4974140c9ce84a528d063eae19f7f881d38e"
            },
            "downloads": -1,
            "filename": "z_backup-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d4b4d0283ad41e554402c4dba4a23f74",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.12",
            "size": 3356,
            "upload_time": "2024-10-04T06:20:11",
            "upload_time_iso_8601": "2024-10-04T06:20:11.774504Z",
            "url": "https://files.pythonhosted.org/packages/12/51/b6e2120ec7699ac0b3c071355bf16c1d46c82360b1ddc8faa6a55b35d53a/z_backup-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-04 06:20:11",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "z-backup"
}
        
Elapsed time: 0.96162s